| Name | vcfzap JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | A lightning-fast VCF contact extractor to CSV, TXT, JSON, HTML, SQLite, or terminal preview |
| upload_time | 2025-07-24 09:51:28 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License
Copyright (c) 2025 mallikmusaddiq1
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
vcf
contact
extractor
csv
json
txt
html
sqlite
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# vcfzap
**vcfzap** is a high-performance, feature-rich command-line tool that extracts contact information from VCF (vCard) files and exports it into multiple formats: CSV, TXT, JSON, HTML, SQLite, or a color-coded terminal preview. Whether you're a developer, sysadmin, or power user, vcfzap makes contact extraction seamless and efficient.
---
<p align="center">
<img src="https://img.shields.io/pypi/v/vcfzap?color=blue&label=PyPI&logo=pypi&style=flat-square">
<img src="https://img.shields.io/pypi/dm/vcfzap?color=orange&label=Downloads&logo=python&style=flat-square">
<img src="https://static.pepy.tech/badge/vcfzap" alt="Total Downloads">
<img src="https://img.shields.io/github/license/mallikmusaddiq1/vcfzap?style=flat-square&color=green">
<img src="https://img.shields.io/github/stars/mallikmusaddiq1/vcfzap?style=flat-square&label=Stars&color=yellow">
<img src="https://img.shields.io/github/last-commit/mallikmusaddiq1/vcfzap?style=flat-square&color=purple">
<img src="https://img.shields.io/github/languages/top/mallikmusaddiq1/vcfzap?style=flat-square&color=blueviolet">
<img src="https://img.shields.io/github/languages/code-size/mallikmusaddiq1/vcfzap?style=flat-square&color=teal">
<img src="https://img.shields.io/badge/made%20with-%E2%9D%A4%EF%B8%8F%20in%20Python-blue?style=flat-square">
</p>
---
## ✨ Key Features
* 🚀 **Multi-format Export**: Convert `.vcf` files to CSV, TXT, JSON, HTML, or SQLite database.
* 🧩 **Field Selection**: Choose exactly which fields to extract: name, phone, email, address, organization.
* 🔍 **Dry Run Mode**: Simulate output without creating any files — perfect for testing.
* 🌐 **Encoding Detection**: Automatically handles VCFs with different character encodings.
* 🔐 **Safe Overwriting**: Built-in prompts to prevent accidental file overwrite and respect for permissions.
* ⚡ **Performance-focused**: Fast parsing with progress display — handles large files effortlessly.
* ⌚ **Timestamp Support**: Automatically append timestamps to output filenames.
* 🧘 **Automation-friendly**: Flags like `--no-color`, `--quiet`, and `--no-prompt` are ideal for scripting and CI.
* 💽 **Rich Terminal Preview**: View a beautiful table-rendered contact list directly in the terminal.
* 🛠 **Verbose Logging**: Output logs to file and optionally enable debug mode for advanced insight.
---
## ⚙ Installation
### 📦 Install via PyPI
```bash
pip install vcfzap
```
### 🧬 Install from GitHub (latest)
```bash
git clone https://github.com/musaddiq/vcfzap.git
cd vcfzap
pip install .
```
---
## 🧪 Basic Usage
```bash
vcfzap <VCF_FILE> [OPTIONS]
```
### ✅ Examples
```bash
vcfzap contacts.vcf --preview --limit 5
vcfzap contacts.vcf --csv output.csv --timestamp
vcfzap contacts.vcf --json contacts.json --fields name,phone,email --pretty-json
vcfzap contacts.vcf --html contacts.html --fields email
vcfzap contacts.vcf --sqlite contacts.db --no-prompt
vcfzap --check-dependencies
```
---
## ⚙ Options & Arguments
### 📅 Input
* `vcf_file` (positional): Path to your `.vcf` file.
### 🎯 Output Formats *(choose one)*
* `--csv <file>`: Export to CSV file
* `--txt <file>`: Export to plain text file
* `--json <file>`: Export to JSON file
* `--html <file>`: Export to styled HTML table
* `--sqlite <file>`: Export to SQLite database
* `--preview`: Show contacts in a color-coded terminal table (no file output)
### 🎛 Behavior & Customization
* `--fields name,phone,email`: Comma-separated list of fields to extract
* `--limit N`: Limit number of contacts
* `--timestamp`: Add current timestamp to output filename
* `--max-size N`: Warn if file is larger than N MB
* `--detect-encoding`: Automatically detect file encoding
* `--csv-delimiter ";"`: Set custom delimiter for CSV export
* `--log-file <file>`: Save detailed logs to specified file
* `--no-color`: Disable colored CLI output
* `--quiet`: Suppress non-essential messages
* `--no-logs`: Disable logging entirely
* `--no-prompt`: Disable all interactive prompts (force overwrite, large file warning)
* `--pretty-json`: Enable human-readable indented JSON
* `--check-dependencies`: Check for any missing Python dependencies
* `-v`, `--version`: Show version information
---
## 🌐 Field Reference
| Field | Description |
| -------------- | -------------------------------------- |
| `name` | Full name (e.g., John Doe) |
| `phone` | Phone numbers with optional extensions |
| `email` | Email addresses |
| `address` | Full physical address |
| `organization` | Company or organization name |
---
## 📦 Output Format Overview
| Format | Description |
| ------- | ----------------------------------------- |
| CSV | Clean spreadsheet with optional delimiter |
| TXT | Readable text with labeled fields |
| JSON | Compact or pretty-printed structure |
| HTML | Styled responsive HTML table |
| SQLite | Structured database with dynamic schema |
| Preview | Terminal-based color table preview only |
---
## ❗ Notes
* Only one output format can be specified per command.
* Use `--dry-run` to verify before exporting.
* Ideal for automation pipelines via `--no-prompt`, `--quiet`, and `--log-file`.
---
## 🧑💻 Advanced Usage
```bash
vcfzap mycontacts.vcf \
--csv contacts.csv \
--fields name,email,address \
--timestamp \
--detect-encoding \
--log-file logs/vcfzap.log \
--quiet
```
---
## 🛡 License
MIT License
---
## 👨💻 Author
**Crafted with intent by [Mallik Mohammad Musaddiq](https://github.com/musaddiqmalik)**
**📧 [musaddiqmalik@gmail.com](mailto:musaddiqmalik@gmail.com)**
**🔗 [GitHub Repo](https://github.com/mallikmusaddiq1/vcfzap)**
---
## 🔍 Like vcfzap?
If this tool made your workflow easier, consider ⭐️ starring the repository or sharing it with others in need.
*
**📧 [musaddiqmalik@gmail.com](mailto:musaddiqmalik@gmail.com)**
**🔗 [GitHub Repo](https://github.com/mallikmusaddiq1/vcfzap)**
---
## 🔍 Like vcfzap?
If this tool made your workflow easier, consider ⭐️ starring the repository or sharing it with others in need.
Raw data
{
"_id": null,
"home_page": null,
"name": "vcfzap",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "vcf, contact, extractor, csv, json, txt, html, sqlite",
"author": null,
"author_email": "Mallik Mohammad Musaddiq <mallikmusaddiq1@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7e/cd/4ba15eb688010932190aeca47374290e88b55b08ee746561a28d979c905b/vcfzap-1.2.0.tar.gz",
"platform": null,
"description": "# vcfzap\n\n**vcfzap** is a high-performance, feature-rich command-line tool that extracts contact information from VCF (vCard) files and exports it into multiple formats: CSV, TXT, JSON, HTML, SQLite, or a color-coded terminal preview. Whether you're a developer, sysadmin, or power user, vcfzap makes contact extraction seamless and efficient.\n\n---\n\n<p align=\"center\">\n <img src=\"https://img.shields.io/pypi/v/vcfzap?color=blue&label=PyPI&logo=pypi&style=flat-square\">\n <img src=\"https://img.shields.io/pypi/dm/vcfzap?color=orange&label=Downloads&logo=python&style=flat-square\">\n <img src=\"https://static.pepy.tech/badge/vcfzap\" alt=\"Total Downloads\">\n <img src=\"https://img.shields.io/github/license/mallikmusaddiq1/vcfzap?style=flat-square&color=green\">\n <img src=\"https://img.shields.io/github/stars/mallikmusaddiq1/vcfzap?style=flat-square&label=Stars&color=yellow\">\n <img src=\"https://img.shields.io/github/last-commit/mallikmusaddiq1/vcfzap?style=flat-square&color=purple\">\n <img src=\"https://img.shields.io/github/languages/top/mallikmusaddiq1/vcfzap?style=flat-square&color=blueviolet\">\n <img src=\"https://img.shields.io/github/languages/code-size/mallikmusaddiq1/vcfzap?style=flat-square&color=teal\">\n <img src=\"https://img.shields.io/badge/made%20with-%E2%9D%A4%EF%B8%8F%20in%20Python-blue?style=flat-square\">\n</p>\n\n---\n\n## \u2728 Key Features\n\n* \ud83d\ude80 **Multi-format Export**: Convert `.vcf` files to CSV, TXT, JSON, HTML, or SQLite database.\n* \ud83e\udde9 **Field Selection**: Choose exactly which fields to extract: name, phone, email, address, organization.\n* \ud83d\udd0d **Dry Run Mode**: Simulate output without creating any files \u2014 perfect for testing.\n* \ud83c\udf10 **Encoding Detection**: Automatically handles VCFs with different character encodings.\n* \ud83d\udd10 **Safe Overwriting**: Built-in prompts to prevent accidental file overwrite and respect for permissions.\n* \u26a1 **Performance-focused**: Fast parsing with progress display \u2014 handles large files effortlessly.\n* \u231a **Timestamp Support**: Automatically append timestamps to output filenames.\n* \ud83e\uddd8 **Automation-friendly**: Flags like `--no-color`, `--quiet`, and `--no-prompt` are ideal for scripting and CI.\n* \ud83d\udcbd **Rich Terminal Preview**: View a beautiful table-rendered contact list directly in the terminal.\n* \ud83d\udee0 **Verbose Logging**: Output logs to file and optionally enable debug mode for advanced insight.\n\n---\n\n## \u2699 Installation\n\n### \ud83d\udce6 Install via PyPI\n\n```bash\npip install vcfzap\n```\n\n### \ud83e\uddec Install from GitHub (latest)\n\n```bash\ngit clone https://github.com/musaddiq/vcfzap.git\ncd vcfzap\npip install .\n```\n\n---\n\n## \ud83e\uddea Basic Usage\n\n```bash\nvcfzap <VCF_FILE> [OPTIONS]\n```\n\n### \u2705 Examples\n\n```bash\nvcfzap contacts.vcf --preview --limit 5\nvcfzap contacts.vcf --csv output.csv --timestamp\nvcfzap contacts.vcf --json contacts.json --fields name,phone,email --pretty-json\nvcfzap contacts.vcf --html contacts.html --fields email\nvcfzap contacts.vcf --sqlite contacts.db --no-prompt\nvcfzap --check-dependencies\n```\n\n---\n\n## \u2699 Options & Arguments\n\n### \ud83d\udcc5 Input\n\n* `vcf_file` (positional): Path to your `.vcf` file.\n\n### \ud83c\udfaf Output Formats *(choose one)*\n\n* `--csv <file>`: Export to CSV file\n* `--txt <file>`: Export to plain text file\n* `--json <file>`: Export to JSON file\n* `--html <file>`: Export to styled HTML table\n* `--sqlite <file>`: Export to SQLite database\n* `--preview`: Show contacts in a color-coded terminal table (no file output)\n\n### \ud83c\udf9b Behavior & Customization\n\n* `--fields name,phone,email`: Comma-separated list of fields to extract\n* `--limit N`: Limit number of contacts\n* `--timestamp`: Add current timestamp to output filename\n* `--max-size N`: Warn if file is larger than N MB\n* `--detect-encoding`: Automatically detect file encoding\n* `--csv-delimiter \";\"`: Set custom delimiter for CSV export\n* `--log-file <file>`: Save detailed logs to specified file\n* `--no-color`: Disable colored CLI output\n* `--quiet`: Suppress non-essential messages\n* `--no-logs`: Disable logging entirely\n* `--no-prompt`: Disable all interactive prompts (force overwrite, large file warning)\n* `--pretty-json`: Enable human-readable indented JSON\n* `--check-dependencies`: Check for any missing Python dependencies\n* `-v`, `--version`: Show version information\n\n---\n\n## \ud83c\udf10 Field Reference\n\n| Field | Description |\n| -------------- | -------------------------------------- |\n| `name` | Full name (e.g., John Doe) |\n| `phone` | Phone numbers with optional extensions |\n| `email` | Email addresses |\n| `address` | Full physical address |\n| `organization` | Company or organization name |\n\n---\n\n## \ud83d\udce6 Output Format Overview\n\n| Format | Description |\n| ------- | ----------------------------------------- |\n| CSV | Clean spreadsheet with optional delimiter |\n| TXT | Readable text with labeled fields |\n| JSON | Compact or pretty-printed structure |\n| HTML | Styled responsive HTML table |\n| SQLite | Structured database with dynamic schema |\n| Preview | Terminal-based color table preview only |\n\n---\n\n## \u2757 Notes\n\n* Only one output format can be specified per command.\n* Use `--dry-run` to verify before exporting.\n* Ideal for automation pipelines via `--no-prompt`, `--quiet`, and `--log-file`.\n\n---\n\n## \ud83e\uddd1\u200d\ud83d\udcbb Advanced Usage\n\n```bash\nvcfzap mycontacts.vcf \\\n --csv contacts.csv \\\n --fields name,email,address \\\n --timestamp \\\n --detect-encoding \\\n --log-file logs/vcfzap.log \\\n --quiet\n```\n\n---\n\n## \ud83d\udee1 License\n\nMIT License\n---\n\n## \ud83d\udc68\u200d\ud83d\udcbb Author\n\n**Crafted with intent by [Mallik Mohammad Musaddiq](https://github.com/musaddiqmalik)**\n**\ud83d\udce7 [musaddiqmalik@gmail.com](mailto:musaddiqmalik@gmail.com)**\n**\ud83d\udd17 [GitHub Repo](https://github.com/mallikmusaddiq1/vcfzap)**\n\n---\n\n## \ud83d\udd0d Like vcfzap?\n\nIf this tool made your workflow easier, consider \u2b50\ufe0f starring the repository or sharing it with others in need.\n*\n**\ud83d\udce7 [musaddiqmalik@gmail.com](mailto:musaddiqmalik@gmail.com)**\n**\ud83d\udd17 [GitHub Repo](https://github.com/mallikmusaddiq1/vcfzap)**\n\n---\n\n## \ud83d\udd0d Like vcfzap?\n\nIf this tool made your workflow easier, consider \u2b50\ufe0f starring the repository or sharing it with others in need.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 mallikmusaddiq1\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A lightning-fast VCF contact extractor to CSV, TXT, JSON, HTML, SQLite, or terminal preview",
"version": "1.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/mallikmusaddiq1/vcfzap/issues",
"Documentation": "https://github.com/mallikmusaddiq1/vcfzap/tree/master/docs",
"Homepage": "https://github.com/mallikmusaddiq1/vcfzap"
},
"split_keywords": [
"vcf",
" contact",
" extractor",
" csv",
" json",
" txt",
" html",
" sqlite"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b4add865fa71c9fad22f75a8723831866a070cd9837385ee26f8c70763f71d77",
"md5": "537c8a1e62f371d2ba64822a04abf838",
"sha256": "4d4fc9af3412d5a267c21df51a4aed43e9b40285b83d6afc404d77e094ebbfaf"
},
"downloads": -1,
"filename": "vcfzap-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "537c8a1e62f371d2ba64822a04abf838",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17768,
"upload_time": "2025-07-24T09:51:26",
"upload_time_iso_8601": "2025-07-24T09:51:26.039683Z",
"url": "https://files.pythonhosted.org/packages/b4/ad/d865fa71c9fad22f75a8723831866a070cd9837385ee26f8c70763f71d77/vcfzap-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7ecd4ba15eb688010932190aeca47374290e88b55b08ee746561a28d979c905b",
"md5": "2ed74e1d3df5176b1d54e39e5b09c53d",
"sha256": "1f69e80f48bbbe42552adf84bbae05ae2a1505d63801863136e9854404e28a5e"
},
"downloads": -1,
"filename": "vcfzap-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2ed74e1d3df5176b1d54e39e5b09c53d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 20337,
"upload_time": "2025-07-24T09:51:28",
"upload_time_iso_8601": "2025-07-24T09:51:28.217903Z",
"url": "https://files.pythonhosted.org/packages/7e/cd/4ba15eb688010932190aeca47374290e88b55b08ee746561a28d979c905b/vcfzap-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-24 09:51:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mallikmusaddiq1",
"github_project": "vcfzap",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vcfzap"
}
