[](https://github.com/talk2bryan/vcf-generator/actions/workflows/ci.yml)
[](https://codecov.io/gh/talk2bryan/vcf-generator)
[](https://badge.fury.io/py/vcf-generator)
[](https://pypi.org/project/vcf-generator/)
[](https://pypi.org/project/vcf-generator/)
[](https://pypi.org/project/vcf-generator/)
[](https://pypi.org/project/vcf-generator/)
# vcf-generator
A simple VCF generator. Generate VCF files with random data.
## Installation
Using pip:
```bash
pip install vcf-generator
```
## Quick Start
```bash
$ vcf-generator vcards --output-file test.vcf --num_contacts 1000
$ vcf-generator contacts_str --output-file test.txt --num_contacts 1000
```
## Command Line Interface
```bash
$ vcf-generator --help
Usage: vcf-generator [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
contacts_str Generate contacts as string
vcards Generate contacts in VCF format (4.0)
```
See help for each command:
```bash
$ vcf-generator COMMAND --help
Usage: vcf-generator COMMAND [OPTIONS]
Generate contacts in VCF format (4.0)
Options:
-o, --output-file TEXT Output file [optional]
-n, --num_contacts INTEGER Number of contacts to generate [optional]
--help Show this message and exit.
```
## Examples
### Generate VCF data with 1 contact
```bash
$ vcf-generator vcards
```
The above command will generate 1 contact as a VCF string and print the content to the console:
```bash
BEGIN:VCARD
VERSION:4.0
N:None;Laura;Valerie;;Miss
FN:Laura Valerie
TITLE:Miss
TEL;TYPE#HOME,voice;VALUE#uri:tel:+859-422-5863580
TEL;TYPE#MOBILE,voice;VALUE#uri:tel:+528-463-7642962
TEL;TYPE#MOBILE,voice;VALUE#uri:tel:+51-666-1415776
ADR;TYPE#WORK;PREF#1;LABEL#13962 Casey Spring Suite 931
Xavierfurt, VT 65391
Suriname:;;13962 Casey Spring Suite 931;Xavierfurt;VT;65391;Suriname
ADR;TYPE#OTHER;PREF#2;LABEL#33446 Deanna Prairie Apt. 140
Mcguireport, NJ 64518
Tokelau:;;33446 Deanna Prairie Apt. 140;Mcguireport;NJ;64518;Tokelau
BDAY:1959-08-06
EMAIL:caleb93@example.org
EMAIL:christopherblankenship@example.org
EMAIL:michaelwhite@example.org
END:VCARD
```
### Generate 1 contact as string
```bash
$ vcf-generator contacts_str
```
The above command will generate 1 contact information and print the content to the console:
```bash
Name: Charles Rebekah - Ind.
DOB: 1953-11-18
Phone Numbers: HOME: +738 (250) 705-2590. OTHER: +432 (509) 404-8152. MOBILE: +601 (647) 746-1060
Emails: OTHER: daniel03@example.org
Addresses: OTHER: 557 Ruiz Avenue, 7934 Westmouth, KY 56508 Guyana
```
Raw data
{
"_id": null,
"home_page": "https://github.com/talk2bryan/vcf-generator",
"name": "vcf-generator",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "vcf, generator, vcard, contacts, faker, python",
"author": "Bryan Wodi",
"author_email": "pypi.envy443@dralias.com",
"download_url": "https://files.pythonhosted.org/packages/81/98/686c6b5c2cdc91baa4e04543e516798367f976a7a59cfe06ec9a768d2778/vcf_generator-1.1.7.tar.gz",
"platform": null,
"description": "[](https://github.com/talk2bryan/vcf-generator/actions/workflows/ci.yml)\n[](https://codecov.io/gh/talk2bryan/vcf-generator)\n[](https://badge.fury.io/py/vcf-generator)\n[](https://pypi.org/project/vcf-generator/)\n[](https://pypi.org/project/vcf-generator/)\n[](https://pypi.org/project/vcf-generator/)\n[](https://pypi.org/project/vcf-generator/)\n\n# vcf-generator\n\nA simple VCF generator. Generate VCF files with random data.\n\n## Installation\nUsing pip:\n```bash\npip install vcf-generator\n```\n## Quick Start\n```bash\n$ vcf-generator vcards --output-file test.vcf --num_contacts 1000\n$ vcf-generator contacts_str --output-file test.txt --num_contacts 1000\n```\n\n## Command Line Interface\n```bash\n$ vcf-generator --help\nUsage: vcf-generator [OPTIONS] COMMAND [ARGS]...\nOptions:\n --help Show this message and exit.\nCommands:\n contacts_str Generate contacts as string\n vcards Generate contacts in VCF format (4.0)\n```\n\nSee help for each command:\n\n```bash\n$ vcf-generator COMMAND --help\nUsage: vcf-generator COMMAND [OPTIONS]\n Generate contacts in VCF format (4.0)\nOptions:\n -o, --output-file TEXT Output file [optional]\n -n, --num_contacts INTEGER Number of contacts to generate [optional]\n --help Show this message and exit.\n```\n\n\n## Examples\n### Generate VCF data with 1 contact\n```bash\n$ vcf-generator vcards\n```\n\nThe above command will generate 1 contact as a VCF string and print the content to the console:\n\n```bash\nBEGIN:VCARD\nVERSION:4.0\nN:None;Laura;Valerie;;Miss\nFN:Laura Valerie\nTITLE:Miss\nTEL;TYPE#HOME,voice;VALUE#uri:tel:+859-422-5863580\nTEL;TYPE#MOBILE,voice;VALUE#uri:tel:+528-463-7642962\nTEL;TYPE#MOBILE,voice;VALUE#uri:tel:+51-666-1415776\nADR;TYPE#WORK;PREF#1;LABEL#13962 Casey Spring Suite 931\nXavierfurt, VT 65391\nSuriname:;;13962 Casey Spring Suite 931;Xavierfurt;VT;65391;Suriname\nADR;TYPE#OTHER;PREF#2;LABEL#33446 Deanna Prairie Apt. 140\nMcguireport, NJ 64518\nTokelau:;;33446 Deanna Prairie Apt. 140;Mcguireport;NJ;64518;Tokelau\nBDAY:1959-08-06\nEMAIL:caleb93@example.org\nEMAIL:christopherblankenship@example.org\nEMAIL:michaelwhite@example.org\nEND:VCARD\n```\n\n### Generate 1 contact as string\n```bash\n$ vcf-generator contacts_str\n```\n\nThe above command will generate 1 contact information and print the content to the console:\n\n```bash\nName: Charles Rebekah - Ind.\nDOB: 1953-11-18\nPhone Numbers: HOME: +738 (250) 705-2590. OTHER: +432 (509) 404-8152. MOBILE: +601 (647) 746-1060\nEmails: OTHER: daniel03@example.org\nAddresses: OTHER: 557 Ruiz Avenue, 7934 Westmouth, KY 56508 Guyana\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple VCF generator. Generate VCF files with random data.",
"version": "1.1.7",
"project_urls": {
"Bug Tracker": "https://github.com/talk2bryan/vcf-generator/issues",
"Homepage": "https://github.com/talk2bryan/vcf-generator",
"Repository": "https://github.com/talk2bryan/vcf-generator"
},
"split_keywords": [
"vcf",
" generator",
" vcard",
" contacts",
" faker",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fadb9873374710eeba9c9278e97180328f37e2d4ad992baee9882a5368120749",
"md5": "f2d6ef30aae6445054e1e150207d0cc3",
"sha256": "e107ec89092a8ea1b2e31c13fd9ac4f442df53a57e406e34b2a89b34896dca3b"
},
"downloads": -1,
"filename": "vcf_generator-1.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f2d6ef30aae6445054e1e150207d0cc3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 8413,
"upload_time": "2024-04-08T04:18:37",
"upload_time_iso_8601": "2024-04-08T04:18:37.170151Z",
"url": "https://files.pythonhosted.org/packages/fa/db/9873374710eeba9c9278e97180328f37e2d4ad992baee9882a5368120749/vcf_generator-1.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8198686c6b5c2cdc91baa4e04543e516798367f976a7a59cfe06ec9a768d2778",
"md5": "be0c0d4e9263c989db0847e1f17464ee",
"sha256": "5ee4a4b1067989e9b44824cdee90b178fc4211ca1d2fe5482655e36ceb268093"
},
"downloads": -1,
"filename": "vcf_generator-1.1.7.tar.gz",
"has_sig": false,
"md5_digest": "be0c0d4e9263c989db0847e1f17464ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 9321,
"upload_time": "2024-04-08T04:18:38",
"upload_time_iso_8601": "2024-04-08T04:18:38.727371Z",
"url": "https://files.pythonhosted.org/packages/81/98/686c6b5c2cdc91baa4e04543e516798367f976a7a59cfe06ec9a768d2778/vcf_generator-1.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-08 04:18:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "talk2bryan",
"github_project": "vcf-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vcf-generator"
}
JSON
