PDFwerks

PDFwerks is a lightweight yet comprehensive tool for working with PDFs directly from your terminal. It provides essential PDF manipulation tools all in one easy to use package

Why PDFwerks?
Well, a few months ago, I needed to merge some important stuff like my Aadhaar and other IDs. I used the usual online tools, but it got me thinking, "Who even knows what happens to my files after I upload them?" That’s when I decided to build PDFwerks - a local tool that keeps your documents safe and under your control.

License

Tools Available

✅ Merge PDFs, images, and text files into a single PDF
✅ Compress PDFs with three adjustable compression levels
✅ Convert images to a PDF
✅ Extract text from a PDF to plain text, markdown or json
✅ PDF Security operations
✅ Delete Pages from a PDF

No uploads required

All operations happen locally on your machine, ensuring your sensitive documents stay secure and private. No shady websites. No dumb paid subscriptions.

Cross Platform Support

PDFwerks is a cross platform PDF toolkit and works across all major operating systems.

It has been locally tested and verified on both Ubuntu (including WSL2) and Windows. Additionally, Continuous Integration (CI) tests are run on Windows, macOS, and Ubuntu, ensuring core functionality remains stable across environments.

Important: tkinter is a required dependency for PDFwerks.

Installing tkinter by platform:

Windows & macOS:

Python installed from python.org includes tkinter by default, so no extra steps are usually needed.
Ubuntu/Debian:
```
sudo apt-get install python-tk
```
Arch:
```
sudo pacman -S tk
```
Fedora:
```
sudo dnf install python3-tkinter
```

Installation

Install via pip:

pip install pdfwerks

And that's it, you're good to go! Check out the Getting Started guide to learn how to use PDFwerks.

For Devs: Installation & Setup

Follow these steps to test, contribute, or customize PDFwerks locally:

Clone the repository:

git clone https://github.com/adithya-menon-r/PDFwerks.git
cd PDFwerks

Create a virtual environment and activate it:

python -m venv .venv
.venv\Scripts\activate    # On Linux/Mac: source .venv/bin/activate

Install dependencies and the package in editable mode:
```
pip install -e .
```

Depending on what you are working on, you can install extras as needed:

For tests:
```
pip install -e .[test]
```
For documentation:
```
pip install -e .[docs]
```

You can now make changes to the code, run tests, or build documentation without reinstalling the package.

Running Tests

Once test dependencies are installed (using pip install -e .[test]), you run the full test suite with:

pytest

All test files are located in the tests/ directory and are automatically discovered by pytest.

License

PDFwerks is licensed under the MIT License