11257e7706
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>
71 lines
1.5 KiB
Text
71 lines
1.5 KiB
Text
# @pdftract/sdk
|
|
|
|
Node.js SDK for pdftract - PDF extraction and conformance testing.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @pdftract/sdk@{{ version }}
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic extract
|
|
|
|
```typescript
|
|
import { Client, path } from '@pdftract/sdk';
|
|
|
|
const client = new Client();
|
|
const doc = await client.extract(path('document.pdf'));
|
|
console.log(`Pages: ${doc.pages.length}`);
|
|
```
|
|
|
|
### Extract with OCR
|
|
|
|
```typescript
|
|
import { Client, path } from '@pdftract/sdk';
|
|
|
|
const client = new Client();
|
|
const doc = await client.extract(path('scanned.pdf'), {
|
|
ocrLanguage: 'eng',
|
|
ocrThreshold: 0.7
|
|
});
|
|
```
|
|
|
|
### Search
|
|
|
|
```typescript
|
|
import { Client, path } from '@pdftract/sdk';
|
|
|
|
const client = new Client();
|
|
for await (const match of client.search(path('document.pdf'), 'invoice')) {
|
|
console.log(`Found on page ${match.page}: ${match.text}`);
|
|
}
|
|
```
|
|
|
|
### Stream extraction
|
|
|
|
```typescript
|
|
import { Client, path } from '@pdftract/sdk';
|
|
|
|
const client = new Client();
|
|
for await (const page of client.extractStream(path('large.pdf'))) {
|
|
console.log(`Page ${page.page}: ${page.blocks.length} 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.
|