pdftract/templates/sdk-skeleton/python-subprocess/README.md.tera
jedarden 11257e7706 feat(pdftract-l993m): complete per-language Tera template scaffolding
Complete the Tera template scaffolding for all 8 subprocess-based SDKs
under templates/sdk-skeleton/<lang>/: node, go, java, dotnet, ruby,
php, swift, python-subprocess.

Each template directory contains:
- Package metadata template (package.json, go.mod, pom.xml, etc.)
- Method stubs template (methods.ts, client.go, Methods.java, etc.)
- Error stubs template (errors.ts, errors.go, Errors.java, etc.)
- Conformance runner template (conformance.test.ts, etc.)
- README template with {{ version }} variable substitution
- GENERATED.tera marker file

New files for python-subprocess:
- pdftract_subprocess/codegen/errors.py.tera
- tests/codegen/conformance_test.py.tera
- README.md.tera
- GENERATED.tera

All 8 language template directories are now complete and ready for
consumption by the `pdftract sdk codegen` subcommand.

Co-Authored-By: Claude Code <noreply@anthropic.com>
2026-05-18 02:01:46 -04:00

71 lines
1.7 KiB
Text

# pdftract-subprocess
Python SDK for pdftract - PDF extraction and conformance testing (subprocess fallback).
This package provides a subprocess-based fallback when the native PyO3 module fails to load. It is slower but provides full functionality.
## Installation
```bash
pip install pdftract-subprocess=={{ version }}
```
## Usage
### Basic extract
```python
from pdftract_subprocess import Client, PathSource
client = Client()
doc = client.extract(PathSource('document.pdf'))
print(f"Pages: {len(doc['pages'])}")
```
### Extract with OCR
```python
from pdftract_subprocess import Client, PathSource
client = Client()
doc = client.extract(PathSource('scanned.pdf'), options={
'ocr_language': 'eng',
'ocr_threshold': 0.7
})
```
### Search
```python
from pdftract_subprocess import Client, PathSource
client = Client()
for match in client.search(PathSource('document.pdf'), 'invoice'):
print(f"Found on page {match['page']}: {match['text']}")
```
### Stream extraction
```python
from pdftract_subprocess import Client, PathSource
client = Client()
for page in client.extract_stream(PathSource('large.pdf')):
print(f"Page {page['page']}: {len(page.get('blocks', []))} blocks")
```
## Binary version compatibility
This SDK requires pdftract {{ version }}. Download from:
https://github.com/jedarden/pdftract/releases/tag/v{{ version }}
## Troubleshooting
### Binary not found
Ensure `pdftract` is on your PATH. The SDK probes PATH for the executable.
### Version mismatch
The SDK will refuse to invoke mismatched binary versions. Install the correct version.
### Network failure
For remote URLs, check your network connection and TLS certificate chain.