Metadata-Version: 2.4
Name: pdfix-cli
Version: 9.1.1
Summary: PDFix SDK command-line tools for PDF accessibility, remediation, extraction, conversion, rendering, and automation.
Author-email: "PDFix s.r.o." <support@pdfix.net>
License: LicenseRef-PDFix
Project-URL: Homepage, https://pdfix.net
Project-URL: Documentation, https://github.com/pdfix/pdfix_sdk_builds
Project-URL: Repository, https://github.com/pdfix/pdfix_sdk_builds
Project-URL: Bug Tracker, https://github.com/pdfix/pdfix_sdk_builds/issues
Project-URL: License, https://pdfix.net/terms
Keywords: pdfix,pdfix-sdk,pdfix-cli,pdf,cli,pdf-cli,pdf-sdk,pdf-automation,pdf-accessibility,pdf-remediation,pdf-ua,wcag,accessible-pdf,pdf-processing,pdf-extraction,pdf-conversion,pdf-rendering,pdf-tags,pdf-forms
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: Other/Proprietary License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# PDFix SDK CLI App

PDFix SDK CLI App packaged for pip.

PDFix SDK is a cross-platform PDF processing toolkit for automating PDF
accessibility, document remediation, data extraction, and PDF conversion
workflows. The PDFix CLI App exposes those SDK capabilities as a command-line
tool for shells, build pipelines, batch jobs, server-side automation, and
Python applications.

This package installs the native PDFix CLI runtime for your platform and
provides console scripts plus a small Python API for invoking the CLI.

## What PDFix CLI App is for

Use PDFix CLI App when you need scriptable PDF automation without integrating
directly with the PDFix SDK API. Common use cases include:

- Automated PDF accessibility remediation for PDF/UA and WCAG-oriented workflows
- Adding and improving tags, document structure, reading order, annotations,
  metadata, and fonts
- Extracting PDF content, forms, bookmarks, tags, page objects, tables, images,
  and document data to formats such as JSON, XML, CSV, text, and images
- Converting PDFs to HTML or structured data for web, archive, review, and
  downstream processing
- Rendering PDF pages to raster images for previews, validation, or QA
- Applying operations such as watermarking, flattening, redaction, page
  insert/delete/move, digital signatures, form import/export, and security
  removal
- Running batch processing and JSON-configured PDF Actions in production
  pipelines

## Install

```sh
pip install pdfix-cli
```

Pip selects the matching platform wheel automatically (Windows x64, Linux
x86_64 / aarch64, macOS Intel / Apple Silicon).

## Console usage

After installation, any of these commands invoke the native PDFix CLI App:

```sh
pdfix-cli --version
pdfix --help
pdfix_app make-accessible input.pdf -o output.pdf
```

Arguments are forwarded unchanged to the native executable. Exit code, stdout,
and stderr are preserved.

## Python API

```python
from pdfix_cli import (
  get_pdfix_cli_path,
  is_pdfix_cli_available,
  run_pdfix_cli,
)

if not is_pdfix_cli_available():
  raise RuntimeError("PDFix CLI runtime is not installed for this platform.")

print(get_pdfix_cli_path())

child = run_pdfix_cli(["--version"])
child.wait()
```

- `get_pdfix_cli_path()` — absolute path to the bundled `pdfix_app` executable
- `is_pdfix_cli_available()` — whether the runtime can be resolved
- `run_pdfix_cli(args)` — spawn the CLI (inherits stdio by default)

## Supported platforms

| Platform | Wheel tag |
|----------|-----------|
| Windows x64 | `win_amd64` |
| Linux x86_64 | `manylinux_2_17_x86_64` |
| Linux aarch64 | `manylinux_2_17_aarch64` |
| macOS Intel | `macosx_10_13_x86_64` |
| macOS Apple Silicon | `macosx_11_0_arm64` |

Requires Python 3.8+.

## Links

- Homepage: https://pdfix.net
- Releases / issues: https://github.com/pdfix/pdfix_sdk_builds
- License / terms: https://pdfix.net/terms

## License

PDFix SDK Lite is licensed under Apache 2.0. Other versions of the PDFix SDK
are licensed under the terms published at https://pdfix.net/terms.
