Metadata-Version: 2.5
Name: suketchi
Version: 0.1.2
Summary: A lightweight, free, and open-source PDF reader and editor.
Project-URL: Homepage, https://github.com/nafeeur/suketchi-pdf-editor
Project-URL: Repository, https://github.com/nafeeur/suketchi-pdf-editor
Project-URL: Issues, https://github.com/nafeeur/suketchi-pdf-editor/issues
Author: Nafeeur Rahman
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Keywords: gui,pdf,pdf-editor,pdf-reader,pyqt6
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Graphics :: Editors :: Vector-Based
Classifier: Topic :: Office/Business
Requires-Python: >=3.10
Requires-Dist: pymupdf>=1.23
Requires-Dist: pyqt6>=6.4
Requires-Dist: pyshortcuts>=1.9
Provides-Extra: all
Requires-Dist: pyhanko-certvalidator>=0.26; extra == 'all'
Requires-Dist: pyhanko>=0.22; extra == 'all'
Requires-Dist: pyspellchecker>=0.7; extra == 'all'
Requires-Dist: python-docx>=1.0; extra == 'all'
Provides-Extra: docx
Requires-Dist: python-docx>=1.0; extra == 'docx'
Provides-Extra: sign
Requires-Dist: pyhanko-certvalidator>=0.26; extra == 'sign'
Requires-Dist: pyhanko>=0.22; extra == 'sign'
Provides-Extra: spellcheck
Requires-Dist: pyspellchecker>=0.7; extra == 'spellcheck'
Description-Content-Type: text/markdown

![PDF Editor Banner](https://raw.githubusercontent.com/nafeeur/suketchi-pdf-editor/main/docs/screenshots/banner.jpg)

## A lightweight, free, and open-source PDF reader and editor.

Suketchi PDF delivers a smooth, native desktop experience for viewing, navigating, and editing PDF documents without heavy resource overhead.

---

## Screenshots

![Editing a PDF in Suketchi](https://raw.githubusercontent.com/nafeeur/suketchi-pdf-editor/main/docs/screenshots/screenshot1.jpg)

![Suketchi tools panel](https://raw.githubusercontent.com/nafeeur/suketchi-pdf-editor/main/docs/screenshots/screenshot2.jpg)

![Suketchi page view](https://raw.githubusercontent.com/nafeeur/suketchi-pdf-editor/main/docs/screenshots/screenshot3.jpg)

---

## Installation & Setup

### Prerequisites
* Python 3.10 or higher installed on your computer.

### Install from PyPI
It is highly recommended to isolate the install using a virtual environment:

* **Linux / macOS**:
  ```bash
  python3 -m venv venv
  source venv/bin/activate
  ```
* **Windows**:
  ```bash
  python -m venv venv
  venv\Scripts\activate
  ```

Then install with pip:
```bash
pip install --upgrade pip
pip install suketchi
```

Optional extras add support for spell checking, DOCX export, and cryptographic PDF signing:
```bash
pip install "suketchi[all]"
```

## Running the Application

Once installed, launch the editor with:
```bash
suketchi
```

The first time you run it, Suketchi automatically adds itself to your applications
menu (Linux), Start Menu (Windows), or Applications folder (macOS) with its icon,
so afterwards you can just launch it like any other installed app. (pip cannot run
this step during `pip install` itself — it happens on first launch instead.) To
add or refresh the shortcut manually, run:
```bash
suketchi --install-shortcut
```

### Running from source
```bash
git clone https://github.com/nafeeur/suketchi-pdf-editor
cd suketchi-pdf-editor
pip install -e .
suketchi
```

---

## License

This project is licensed under the GPL-3.0 License. See the LICENSE for more details.
