Skip to content

Commit

Permalink
Update and rename README.rst to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tech4242 authored Apr 24, 2018
1 parent ef420a5 commit d18fa3a
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.rst → README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
[![Downloads](http://pepy.tech/badge/csv2vcard)](http://pepy.tech/count/csv2vcard)

csv2vcard
=========
A Python script that parses a .csv file of contacts and automatically creates vCards. The vCards are super useful for sending your contact details or those of your team. You can also upload them to e.g. Dropbox and use them with QR codes! You can also use them for transferring new contacts to Outlook, a new CRM etc. The specific use case in mind was to programmatically create vCards from a list of contacts in a spreadsheet, to be incorporated into business cards.

Usage
-----

1. Install package with ``pip3 install csv2vcard``
1. Install package with `pip3 install csv2vcard`

2. Create csv file with contacts

*CSV file format (delimeter can be changed in csv_delimeter param, see below)*

``last_name, first_name, org, title, phone, email, website, street, city, p_code, country``
`last_name, first_name, org, title, phone, email, website, street, city, p_code, country`

**Important: you should name the columns exactly the same way because they are used as keys to generate the vCards**

3. ``cd yourcsvfoldername`` go to the folder where you have your csv file
3. `cd yourcsvfoldername` go to the folder where you have your csv file

4. Open python ``python3`` (gotcha: using Python 3.6 features)
4. Open python `python3` (gotcha: using Python 3.6 features)

5. Import module ``from csv2vcard import csv2vcard``
5. Import module `from csv2vcard import csv2vcard`

6. Now you have 2 options for running (both will create an /export/ dir for your vCard):

- Test the app with ``csv2vcard.test_csv2vcard()``. This will create a Forrest Gump test vCard.
- Use your real data ``csv2vcard.csv2vcard("yourcsvfilename", ",")`` where "," is your csv delimeter. This will create all your vCards.
- Test the app with `csv2vcard.test_csv2vcard()`. This will create a Forrest Gump test vCard.
- Use your real data `csv2vcard.csv2vcard("yourcsvfilename", ",")` where "," is your csv delimeter. This will create all your vCards.

0 comments on commit d18fa3a

Please sign in to comment.