README.md

vcf-creator

Generate vCard file from CSV

Usage example

Setup

Cloning the repository:

# Clone the repo
git clone https://github.com/animesh-chouhan/vcf-creator.git
cd vcf-creator

# Run the sample csv file
python3 -m vcf_creator sample.csv

Running tests

# If in vc-creator folder
cd vcf_creator/tests

# Run the test
python3 test_vcf.py

Installation:

To install it right away, type:

pip3 install vcf_creator

Help:

python3 -m vcf_creator --help

OR

vcf_creator --help

Running the script:

python3 -m vcf_creator <csv-file-name>

OR

vcf_creator <csv-file-name>

Import the module in your project:

from vcf_creator import vcard_formatter, vcard_generator

vcard_formatter(arguments)
vcard_generator(arguments)

CSV File Instructions

1. The contact CSV file can have the following headers all in smallcase:
   • name
   • phone
   • organisation
   • email
   • address
   • birthday (mm/dd/yyyy)
2. The headers can be in any order
3. Make sure that no fields are empty

Contributing

1. Fork the repo (https://github.com/animesh-chouhan/vcf-creator/)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

License

MIT License copyright (c) 2021 Animesh Singh Chouhan. Please have a look at the license for more details.