# [vCard module](https://gitlab.com/engmark/vcard)
[](https://www.python.org/)
[](https://gitlab.com/engmark/vcard/-/commits/master)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://www.pylint.org/)
[](https://www.shellcheck.net/)
[](https://conventionalcommits.org)
This program can be used for strict validation and parsing of vCards. It currently supports
[vCard 3.0 (RFC 2426)](https://tools.ietf.org/html/rfc2426).
## Installation
To install or upgrade in a virtualenv:
```shell
pip install --upgrade vcard
```
To use without installing:
```shell
nix-shell
```
See the nixpkgs index for instructions to install the
[command-line tool](https://search.nixos.org/packages?channel=unstable&show=vcard&type=packages&query=vcard)
or the
[Python package](https://search.nixos.org/packages?channel=unstable&show=python311Packages.vcard&type=packages&query=.vcard).
## Usage
See `vcard --help`.
## Utilities
- [`format-TEL.bash`](./format-TEL.bash) - Format phone numbers according to national standards
- [`split.bash`](./split.bash) - Split a multiple vCards file into individual files
- [`sort-lines.bash`](./sort-lines.bash) - Sort vCard property lines according to a custom key
- [`join-lines.sh`](./join-lines.sh) - Join previously split vCard lines
- [`split-lines.sh`](./split-lines.sh) - Split long vCard lines
## Development
### Setup
```shell
git clone git@gitlab.com:engmark/vcard.git
```
### Release
1. Bump the version in [vcard/version.txt](vcard/version.txt)
2. Commit & push everything
3. [Create a new merge request](https://gitlab.com/engmark/vcard/-/merge_requests/new)
4. Wait for the MR to be merged
5. Update to latest `master`
6. `nix-shell --pure --run './clean.bash && ./distribute.bash && ./release.bash'`
Requirements:
- Nix
## Contributing code
You can contribute either by submitting a
[merge requests](https://gitlab.com/engmark/vcard/-/merge_requests) or by
[email](https://gitlab.com/engmark/vcard/-/blob/master/vcard/__init__.py#L6).
Security fixes should only be submitted via email, encrypted with the PGP key
F1C5F63013E5DE2FB574D42ACE5EB38344D85DB6.
Email is also appropriate in some other cases:
- If you don't want to [create a GitLab account](https://gitlab.com/users/sign_up).
- If you want to be _anonymous._ Make sure to be explicit about this! Contributing anonymously
means the following:
- You transfer copyright to me. Otherwise your contribution would make it impossible for future
maintainers to ever change the license - they wouldn't know who to contact to ask for
permission.
- The commit message will make it clear that it was contributed anonymously, with an
"Authored-by: Anonymous <>" line.
- Email submissions must be in patch format, including a detailed commit message, so that it can be
added to the repository without any changes, and without breaking the pipeline.
🚫 Other channels are _not supported._
## How open is this project?
[Background](https://paperless.blog/being-open-about-openness)
- GitLab features:
- All features enabled for this repository are publicly available
- Project settings are private for security reasons
- [Commit history](https://gitlab.com/engmark/vcard/-/commits/master):
- All commits on all branches are publicly visible
- [Issues](https://gitlab.com/engmark/vcard/-/issues):
- Publicly visible
- You need to be logged into GitLab to submit an issue or comment
- Questions from non-users interested in the project are welcome
- Expect answers within a few days
- [Pipelines](https://gitlab.com/engmark/vcard/-/pipelines):
- [The configuration](.gitlab-ci.yml) is publicly visible
- [Runs](https://gitlab.com/engmark/vcard/-/pipelines) are publicly visible
- Logs are publicly visible, and
[logs should be kept indefinitely](https://docs.gitlab.com/ee/user/gitlab_com/#job-logs).
- [Releases](https://pypi.org/project/vcard/):
- Hosted publicly
- [Old releases](https://pypi.org/project/vcard/#history) should be available indefinitely, but
this is under PyPI's control, not mine
- Work (past, current, and planned) is documented publicly within the
[project](https://gitlab.com/engmark/vcard)
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/engmark/vcard",
"name": "vcard",
"maintainer": "Victor Engmark",
"docs_url": null,
"requires_python": "",
"maintainer_email": "victor@engmark.name",
"keywords": "vCard vCards RFC 2426 RFC2426 validator",
"author": "Victor Engmark",
"author_email": "victor@engmark.name",
"download_url": "https://pypi.org/project/vcard/",
"platform": "POSIX",
"description": "# [vCard module](https://gitlab.com/engmark/vcard)\n\n[](https://www.python.org/)\n[](https://gitlab.com/engmark/vcard/-/commits/master)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n[](https://www.pylint.org/)\n[](https://www.shellcheck.net/)\n[](https://conventionalcommits.org)\n\nThis program can be used for strict validation and parsing of vCards. It currently supports\n[vCard 3.0 (RFC 2426)](https://tools.ietf.org/html/rfc2426).\n\n## Installation\n\nTo install or upgrade in a virtualenv:\n\n```shell\npip install --upgrade vcard\n```\n\nTo use without installing:\n\n```shell\nnix-shell\n```\n\nSee the nixpkgs index for instructions to install the\n[command-line tool](https://search.nixos.org/packages?channel=unstable&show=vcard&type=packages&query=vcard)\nor the\n[Python package](https://search.nixos.org/packages?channel=unstable&show=python311Packages.vcard&type=packages&query=.vcard).\n\n## Usage\n\nSee `vcard --help`.\n\n## Utilities\n\n- [`format-TEL.bash`](./format-TEL.bash) - Format phone numbers according to national standards\n- [`split.bash`](./split.bash) - Split a multiple vCards file into individual files\n- [`sort-lines.bash`](./sort-lines.bash) - Sort vCard property lines according to a custom key\n- [`join-lines.sh`](./join-lines.sh) - Join previously split vCard lines\n- [`split-lines.sh`](./split-lines.sh) - Split long vCard lines\n\n## Development\n\n### Setup\n\n```shell\ngit clone git@gitlab.com:engmark/vcard.git\n```\n\n### Release\n\n1. Bump the version in [vcard/version.txt](vcard/version.txt)\n2. Commit & push everything\n3. [Create a new merge request](https://gitlab.com/engmark/vcard/-/merge_requests/new)\n4. Wait for the MR to be merged\n5. Update to latest `master`\n6. `nix-shell --pure --run './clean.bash && ./distribute.bash && ./release.bash'`\n\nRequirements:\n\n- Nix\n\n## Contributing code\n\nYou can contribute either by submitting a\n[merge requests](https://gitlab.com/engmark/vcard/-/merge_requests) or by\n[email](https://gitlab.com/engmark/vcard/-/blob/master/vcard/__init__.py#L6).\n\nSecurity fixes should only be submitted via email, encrypted with the PGP key\nF1C5F63013E5DE2FB574D42ACE5EB38344D85DB6.\n\nEmail is also appropriate in some other cases:\n\n- If you don't want to [create a GitLab account](https://gitlab.com/users/sign_up).\n- If you want to be _anonymous._ Make sure to be explicit about this! Contributing anonymously\n means the following:\n - You transfer copyright to me. Otherwise your contribution would make it impossible for future\n maintainers to ever change the license - they wouldn't know who to contact to ask for\n permission.\n - The commit message will make it clear that it was contributed anonymously, with an\n \"Authored-by: Anonymous <>\" line.\n- Email submissions must be in patch format, including a detailed commit message, so that it can be\n added to the repository without any changes, and without breaking the pipeline.\n\n\ud83d\udeab Other channels are _not supported._\n\n## How open is this project?\n\n[Background](https://paperless.blog/being-open-about-openness)\n\n- GitLab features:\n - All features enabled for this repository are publicly available\n - Project settings are private for security reasons\n- [Commit history](https://gitlab.com/engmark/vcard/-/commits/master):\n - All commits on all branches are publicly visible\n- [Issues](https://gitlab.com/engmark/vcard/-/issues):\n - Publicly visible\n - You need to be logged into GitLab to submit an issue or comment\n - Questions from non-users interested in the project are welcome\n - Expect answers within a few days\n- [Pipelines](https://gitlab.com/engmark/vcard/-/pipelines):\n - [The configuration](.gitlab-ci.yml) is publicly visible\n - [Runs](https://gitlab.com/engmark/vcard/-/pipelines) are publicly visible\n - Logs are publicly visible, and\n [logs should be kept indefinitely](https://docs.gitlab.com/ee/user/gitlab_com/#job-logs).\n- [Releases](https://pypi.org/project/vcard/):\n - Hosted publicly\n - [Old releases](https://pypi.org/project/vcard/#history) should be available indefinitely, but\n this is under PyPI's control, not mine\n- Work (past, current, and planned) is documented publicly within the\n [project](https://gitlab.com/engmark/vcard)\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "vCard validator, class and utility functions",
"version": "0.16.1",
"project_urls": {
"Download": "https://pypi.org/project/vcard/",
"Homepage": "https://gitlab.com/engmark/vcard"
},
"split_keywords": [
"vcard",
"vcards",
"rfc",
"2426",
"rfc2426",
"validator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac877cd2d1995ab2b1655909147c6646e4900969613871c35680374ebca6dd8b",
"md5": "ce9dffe9259a49331be5c229bc217279",
"sha256": "757d3b19c179da10f947a8372d23f49ca9498eb4d9117c82e6ed39077a460f1e"
},
"downloads": -1,
"filename": "vcard-0.16.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ce9dffe9259a49331be5c229bc217279",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 29020,
"upload_time": "2023-12-02T05:18:14",
"upload_time_iso_8601": "2023-12-02T05:18:14.483055Z",
"url": "https://files.pythonhosted.org/packages/ac/87/7cd2d1995ab2b1655909147c6646e4900969613871c35680374ebca6dd8b/vcard-0.16.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-02 05:18:14",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "engmark",
"gitlab_project": "vcard",
"lcname": "vcard"
}
JSON