pdf_oxide 0.3.8

The Complete PDF Toolkit: extract, create, and edit PDFs. Rust core with bindings for Python, Node, WASM, Go, and more.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

# Makefile for PDF Library Python bindings
#
# Common development tasks for building and testing the Python package

.PHONY: dev install test build clean help lint-py fmt-py fmt-py-check check-py

# Development install (editable mode)
# Builds the Rust extension and installs the Python package in development mode
dev:
	maturin develop

# Install in release mode
# Builds the optimized Rust extension and installs the Python package
install:
	maturin develop --release

# Run Python tests
# Executes pytest on the tests/ directory
test:
	pytest tests/

# Run Python tests with verbose output
test-verbose:
	pytest tests/ -v

# Run Python tests with coverage
test-coverage:
	pytest tests/ --cov=pdf_library --cov-report=html

# Build wheel package
# Creates a distributable Python wheel in target/wheels/
build:
	maturin build --release

# Build wheel for all Python versions
build-all:
	maturin build --release --interpreter python3.8 python3.9 python3.10 python3.11 python3.12

# Clean build artifacts
# Removes all build artifacts and compiled extensions
clean:
	cargo clean
	rm -rf target/
	rm -rf python/pdf_library/*.so
	rm -rf python/pdf_library/*.pyd
	rm -rf python/pdf_library/__pycache__
	rm -rf tests/__pycache__
	rm -rf .pytest_cache
	rm -rf htmlcov/
	rm -rf .coverage

# Run Rust tests with Python feature enabled
test-rust:
	cargo test --features python

# Run Clippy linter on Rust code
lint:
	cargo clippy --features python -- -D warnings

# Run Ruff linter on Python code
lint-py:
	ruff check .

# Auto-fix Python linting issues
lint-py-fix:
	ruff check --fix .

# Format Rust code
fmt:
	cargo fmt

# Format Python code with Ruff
fmt-py:
	ruff format .

# Check formatting without modifying files
fmt-check:
	cargo fmt -- --check

# Check Python formatting without modifying files
fmt-py-check:
	ruff format --check .

# Run all Rust checks (format, lint, test)
check: fmt-check lint test-rust

# Run all Python checks (format, lint)
check-py: fmt-py-check lint-py

# Run all checks for both Rust and Python
check-all: check check-py

# Display help
help:
	@echo "PDF Library Python Bindings - Makefile Commands"
	@echo ""
	@echo "Development:"
	@echo "  make dev              - Install in development mode (fast rebuilds)"
	@echo "  make install          - Install in release mode (optimized)"
	@echo ""
	@echo "Testing:"
	@echo "  make test             - Run Python tests"
	@echo "  make test-verbose     - Run Python tests with verbose output"
	@echo "  make test-coverage    - Run Python tests with coverage report"
	@echo "  make test-rust        - Run Rust tests with Python feature"
	@echo ""
	@echo "Building:"
	@echo "  make build            - Build release wheel"
	@echo "  make build-all        - Build wheels for all Python versions"
	@echo ""
	@echo "Code Quality (Rust):"
	@echo "  make lint             - Run Clippy linter on Rust code"
	@echo "  make fmt              - Format Rust code"
	@echo "  make fmt-check        - Check Rust formatting without modifying"
	@echo "  make check            - Run all Rust checks (format, lint, test)"
	@echo ""
	@echo "Code Quality (Python):"
	@echo "  make lint-py          - Run Ruff linter on Python code"
	@echo "  make lint-py-fix      - Auto-fix Python linting issues"
	@echo "  make fmt-py           - Format Python code with Ruff"
	@echo "  make fmt-py-check     - Check Python formatting without modifying"
	@echo "  make check-py         - Run all Python checks (format, lint)"
	@echo ""
	@echo "Code Quality (All):"
	@echo "  make check-all        - Run all checks for both Rust and Python"
	@echo ""
	@echo "Cleanup:"
	@echo "  make clean            - Remove all build artifacts"
	@echo ""
	@echo "Help:"
	@echo "  make help             - Display this help message"