PyContactFile: A simple Python library for processing VCF formats

Supports vCard, hCard, and jCard parsing.

Motivation

Primarily implemented to support the asaperson library.

Limitations

This library was internally based on the pythonvCard4 library. During later testing, it was revealed that the library has some limitations vs. the example(s) given in the specification, including:

• Parsing adr and anniversary fields that are not ISO dates
• Parsing tel and email types that are surrounded by quotation marks
• Parsing geo values that are geo URIs
• Consistently handling and displaying addresses

Currently, this library inherits all these limitations for vCards, and the latter for all inputs.

Prerequisites

• Python 3.11 runtime
• Pip for package installation

Installation

Install the dependencies into the environment with pip:

pip install -r requirements.txt
pip install .

Usage

Call the relevant *card_to_contact to convery a string representing a VCF into a Contact object. See the pythonvCard4 library for details on the output format.

Testing

python3 -m coverage run -m unittest discover -s test -p "*_test.py" && python -m coverage report --skip-covered
python -m coverage html

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ryan Quinn - Initial work

License

MIT.