pdfwerks 0.3.0

A lightweight Python toolkit with multiple tools for PDF manipulation

PDFwerks

PDFwerks is a lightweight yet comprehensive, tool for working with PDFs. It provides essential PDF manipulation tools all in one easy to use package. All operations are performed locally on your machine, ensuring your sensitive documents stay secure and private. With PDFwerks, you can finally say goodbye to uploading your documents to shady websites or paying for basic PDF operations.

Installation

You can install PDFwerks using pip:

pip install pdfwerks

Usage

Run the tool directly from your terminal with:

pdfwerks

Command Line Interface (CLI)

You can also use PDFwerks through the CLI for quick PDF operations without using the TUI.

Merge PDFs

pdfwerks merge file1.pdf file2.pdf [file3.pdf ...] [-o OUTPUT]

• Merge two or more PDF files into one.
• Use -o or --output to specify the output file path. (Defaults to ~Downloads/merged.pdf if not specified)

Help & Version

pdfwerks --help
pdfwerks --version

Note: This project is still a work in progress. Currently, only the Merge PDFs tool is available. More tools and features are in the works.

For Developers

If you want to test, contribute or customize the tool locally:

1. Clone the repository:

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

2. Create a virtual environment and activate it:

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

3. Install dependencies:

   pip install -r requirements.txt
   

4. Install the package in editable mode:

   pip install -e .
   

You can now make changes to the code and test them without reinstalling.

License

This project is licensed under the MIT LICENSE

Author

PDFwerks is developed and maintained by Adithya Menon R