https://github.com/animesh-chouhan/vcf-creator
Generate vCard file from CSV
https://github.com/animesh-chouhan/vcf-creator
csv-to-vcf python vcf vcf-converter
Last synced: 6 months ago
JSON representation
Generate vCard file from CSV
- Host: GitHub
- URL: https://github.com/animesh-chouhan/vcf-creator
- Owner: animesh-chouhan
- License: mit
- Created: 2021-06-24T06:43:56.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-11T03:40:51.000Z (about 4 years ago)
- Last Synced: 2025-03-21T10:21:24.769Z (7 months ago)
- Topics: csv-to-vcf, python, vcf, vcf-converter
- Language: Python
- Homepage: https://animesh-chouhan.github.io/project/vcf_creator/
- Size: 945 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vcf-creator
> Generate vCard file from CSV
## Usage example
## Setup
### Cloning the repository:
```sh
# 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
```sh
# If in vc-creator folder
cd vcf_creator/tests
# Run the test
python3 test_vcf.py
```
### Installation:
To install it right away, type:
```sh
pip3 install vcf_creator
```
### Help:
```sh
python3 -m vcf_creator --help
```
OR
```sh
vcf_creator --help
```
### Running the script:
```sh
python3 -m vcf_creator
```
OR
```sh
vcf_creator
```
### Import the module in your project:
```python
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 ()
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]: https://img.shields.io/github/license/animesh-chouhan/vcf-creator
[wiki]: https://github.com/animesh-chouhan/vcf-creator/wiki
## License
MIT License
copyright (c) 2021 [Animesh Singh Chouhan](https://github.com/animesh-chouhan). Please have a look at the [license](LICENSE) for more details.