Metadata-Version: 2.4
Name: cvfile
Version: 0.1.0
Summary: Reference SDK for the .cv open file format — pack, extract, inspect, validate.
Project-URL: Homepage, https://cvfile.org
Project-URL: Repository, https://github.com/cvfile/cv
Author: cvfile.org
License: Apache-2.0
Keywords: ats,cv,embeddings,markdown,pdf,pdfa,rag,resume
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: pypdf<6,>=5.0
Provides-Extra: dev
Requires-Dist: cbor2>=5.6; extra == 'dev'
Requires-Dist: httpx>=0.27; extra == 'dev'
Requires-Dist: mypy>=1.13; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.7; extra == 'dev'
Provides-Extra: embed
Requires-Dist: cbor2>=5.6; extra == 'embed'
Requires-Dist: httpx>=0.27; extra == 'embed'
Description-Content-Type: text/markdown

# `cvfile`

Reference Python SDK for the [`.cv`](https://cvfile.org) open file format.

## Install

```bash
pip install cvfile
```

## Pack

```python
from cvfile import pack

with open("resume.pdf", "rb") as f:
    pdf_bytes = f.read()
with open("resume.md") as f:
    md = f.read()

cv_bytes = pack(
    pdf=pdf_bytes,
    markdown=md,
    metadata={"primary_language": "en"},
)

with open("resume.cv", "wb") as f:
    f.write(cv_bytes)
```

## Extract

```python
from cvfile import extract, extract_markdown

file = extract(open("resume.cv", "rb").read())
print(file.metadata.version)            # "0.1"
print([p.name for p in file.payloads])  # ['resume.md', 'resume.html']

md = extract_markdown(open("resume.cv", "rb").read())
```

## License

Apache-2.0.
