Metadata-Version: 2.4
Name: openresume-parser
Version: 0.1.1
Summary: Extract structured ATS-friendly JSON from resume PDF files
License-Expression: AGPL-3.0-or-later
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pypdf>=4.0
Provides-Extra: ocr
Requires-Dist: requests>=2.31; extra == "ocr"
Provides-Extra: test
Requires-Dist: pytest>=8.0; extra == "test"
Dynamic: license-file

# OpenResume Parser for Python

`openresume-parser` extracts structured, ATS-friendly resume data from PDF
files. Parsing runs locally by default.

## Install

Install the released package from PyPI:

```powershell
py -m pip install openresume-parser
```

Install the optional OCR support when needed:

```powershell
py -m pip install "openresume-parser[ocr]"
```

## Usage

```python
from openresume import parse_resume_from_pdf

result = parse_resume_from_pdf("resume.pdf")
if result["ok"]:
    print(result["resume"]["contact"]["email"])
else:
    print(result["error"]["code"], result["error"]["message"])

```

PDF parsing uses `pypdf`. OCR.Space is opt-in and requires an API key supplied
by the application:

```python
result = parse_resume_from_pdf(
    "scanned-resume.pdf",
    {"api_key": "your-api-key", "language": "eng"},
)
```

## Build and publish

Run these commands from this directory:

```powershell
py -m pip install --upgrade build twine
py -m build
py -m twine check dist/*
py -m twine upload dist/*
```

For a local install while developing:

```powershell
py -m pip install -e ".[test]"
py -m pytest
```

Do not commit PyPI credentials or OCR API keys. The package requires Python
3.9 or newer.
