Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/augus1999/pypdfeditor-gui

A desktop application to merge, split, add watermark, rotate and rearrange pages, and set password to PDF files. 🖥️ pip install pyPDFeditor-GUI
https://github.com/augus1999/pypdfeditor-gui

desktop-application gui pdf pyqt6 python

Last synced: 6 days ago
JSON representation

A desktop application to merge, split, add watermark, rotate and rearrange pages, and set password to PDF files. 🖥️ pip install pyPDFeditor-GUI

Host: GitHub
URL: https://github.com/augus1999/pypdfeditor-gui
Owner: Augus1999
License: mit
Created: 2021-02-08T11:28:19.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-08-19T05:54:30.000Z (3 months ago)
Last Synced: 2024-10-30T13:52:45.671Z (21 days ago)
Topics: desktop-application, gui, pdf, pyqt6, python
Language: Python
Homepage:
Size: 21.4 MB
Stars: 40
Watchers: 3
Forks: 10
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # pyPDFeditor-GUI

[![PyPI](https://img.shields.io/pypi/v/pyPDFeditor-GUI?color=5f69b4)](https://pypi.org/project/pyPDFeditor-GUI/)

[![Downloads](https://static.pepy.tech/personalized-badge/pyPDFeditor-GUI?period=total&units=international_system&left_color=black&right_color=green&left_text=Downloads)](https://pepy.tech/project/pyPDFeditor-GUI)

![pylint](https://github.com/Augus1999/pyPDFeditor-GUI/actions/workflows/pylint.yml/badge.svg)

![OS](https://img.shields.io/badge/OS-Win%20|%20Linux%20|%20macOS-blue?color=00b166)

![python](https://img.shields.io/badge/Python-≥3.9%20-blue.svg?color=dd9b65)

![PyQt](https://img.shields.io/badge/PyQt-6.7-blue?color=708ddd)

![black](https://img.shields.io/badge/code%20style-black-black)

This project is based on PyQt6 and PyMuPDF and tested on Windows 10 & 11 and Ubuntu on WSL2.

## Welcome 🎃🎉

Welcome to use pyPDFeditor-GUI. pyPDFeditor-GUI is a simple cross-platform application, thanks

to [Python](https://www.python.org/), [PyQt6](https://www.riverbankcomputing.com/software/pyqt/)

and [PyMuPDF](https://github.com/pymupdf/PyMuPDF), designed to work on simple PDF handling.

I tried my best to make it close to Fluent UI. Icons used can be found [🔗here](https://fluenticons.co/).

From version 3.0.0, we have moved the GUI library to PyQt6. If you upgraded from a previous version, you can consider removing PyQt5:

```bash

$ pip uninstall PyQt5 PyQt5-Qt5 PyQt5-sip

```

## Features

* Support 3 languages: English, 日本語 (Japanese), and 中文 (Traditional Chinese)

* Fluent UI design

* Cross-platform support

* Open-source and free to use under MIT licence

* Frameless Window on

  Windows ([Snap Layout](https://answers.microsoft.com/en-us/windows/forum/all/how-to-use-snap-layouts-and-snap-groups-in-windows/3213a6b6-5a33-4d40-bbce-e01388a40976)

  on Windows 11 is supported)

## What's in

* Merge files no matter they are PDF files (`.pdf`), image files (`.jpg` `.png` `.jpeg` `.bmp` `.tiff` `.svg`), or

  e-book files (`.epub` `.xps` `.fb2` `.cbz`) into one PDF file📚

* (...right-click the page then) Delete pages or rearrange pages

* (...right-click the page then) Extract images from a page

* (...right-click the page then) Rotate a page

* (...right-click the page then) Save a page as a PDF file or image file (`.png` `.psd` `.ppm`)

* Add watermark (PDF only)

* Set password either user or/and owner password (PDF only)🔒

* Set permissions (PDF only)🔏

* Edit catalogue structure of the file (PDF only)📑

* Edit metadata of the file (PDF only)📝

* Convert image files or e-book files to PDF

## Requirements 🧩

```text

Python>=3.7

```

```text

PyQt6>=6.7.0

PyMuPDF>=1.24.3

```

## Install & Run

### install from source

you will need `setuptools` and `wheel` installed

```bash

$ cd 

$ pip install .

```

where `` is the directory `setup.py` locates.

### install from PyPi

```bash

$ pip install -U pyPDFeditor-GUI

```

### build thy own package

this requires `build`, `setuptools` and `wheel` installed

```bash

$ pip install -r requirements.txt

$ python -m build

```

### Run

* `$ pdfeditor` to launch the application.

* `$ python -m pypdfeditor_core --reset` to reset the application; this will delete all settings and caches. Default

  settings will be created at next launch.

* `$ python -m pypdfeditor_core --remove` to remove the whole application.

* `$ python -m pypdfeditor_core --debug` to enable showing all mupdf errors and/or warnings.

## Screenshot 🎞️

on Windows 11:



Support [Snap Layouts](https://answers.microsoft.com/en-us/windows/forum/all/how-to-use-snap-layouts-and-snap-groups-in-windows/3213a6b6-5a33-4d40-bbce-e01388a40976)

on Windows 11

## Others

Setting and cache files are stored in the directory `C:\User\USER\.pyPDFeditor-GUI` (Windows) or `home/USER/.pyPDFeditor-GUI`

(Linux and macOS).

Please report any errors to [Issues](https://github.com/Augus1999/pyPDFeditor-GUI/issues). Thank you!