https://github.com/mpcodewriter21/pdf-helper
A simple python script that helps with doing simple stuff with PDFs.
https://github.com/mpcodewriter21/pdf-helper
Last synced: about 1 year ago
JSON representation
A simple python script that helps with doing simple stuff with PDFs.
- Host: GitHub
- URL: https://github.com/mpcodewriter21/pdf-helper
- Owner: MPCodeWriter21
- License: mit
- Created: 2023-05-28T18:46:53.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-21T14:51:31.000Z (over 1 year ago)
- Last Synced: 2025-04-14T17:16:28.641Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
PDF-Helper
==========
A simple python script that helps with doing simple stuff with PDFs. It is going to
become a simple python package after `main.py` reaches 1000 lines of code.
Features
--------
+ [x] Merge PDFs
+ [ ] Split PDFs
+ [x] Export PDF pages as image files
+ [x] Remove pages from a PDF
+ [ ] Encrypt a PDF
+ [ ] Decrypt a PDF
+ [ ] Add watermark to a PDF
+ [ ] Export images from a PDF
+ [x] Export text from a PDF
+ [ ] Export links from a PDF
+ [x] Export one or multiple images as a PDF file
If you want any other feature to be added, feel free to open an [issue](https://github.com/MPCodeWriter21/PDF-To-Image/issues)
or fork the repo and make a [pull request](https://github.com/MPCodeWriter21/PDF-To-Image/pulls)
after adding your contribution.
Usage
-----
### Install requirements
+ Install the most recent version of python for your operating system. Visit [python.org](https://python.org)
+ Clone the repo:
```bash
git clone https://GitHub.com/MPCodeWriter21/PDF-Helper
```
+ Use pip to install the dependencies:
```bash
pip install -r requirements.txt
```
### Merge PDFs
Merge multiple PDFs into one PDF:
```bash
python3 main.py merge -i ... -o
# E.g. Merge PDFs 1, 2 and 3 into a new PDF
python3 main.py merge -i 1.pdf 2.pdf 3.pdf -o new.pdf
### Export PDF pages as image files
Export PDF pages as image files:
```bash
python3 main.py to-image -i -o \
-p ,,..., -s
# E.g. Export pages 1, 2, 3 and 6 from a PDF with scale factor 1
python3 main.py export-pages -i 1.pdf -o images -p 1-3,6 -s 1
# E.g. Export all pages from a PDF with scale 2
python3 main.py to-image -i my-pdf.pdf -o my-images
```
### Remove pages from a PDF
Remove pages from a PDF:
```bash
python3 main.py remove-pages -i -o -p ,,...,
# E.g. Remove pages 1, 2, 3 and 6 from a PDF
python3 main.py remove-pages -i 1.pdf -o new.pdf -p 1-3,6
```
### Export text from a PDF
To extract text from a PDF file and export them to text files you can do as follows:
```bash
python3 main.py extract-text -i -o
# E.g. Extract text from a PDF named my-pdf.pdf and save it to my-text.txt
python3 main.py extract-text -i my-pdf.pdf -o my-text.txt
```
### Export one or multiple images as a PDF file
You simply provide the script with your images, and it will create a PDF file with them:
```bash
python3 main.py image-to-pdf -i ... -o
# E.g. Take 1.png, 2.jpg, and 3.png and create a PDF named 123.pdf and override
# if already exists
python3 main.py -i 1.png 2.jpg 3.png -o 123.pdf -f
```
About
-----
Author: [CodeWriter21](https://github.com/MPCodeWriter21)
GitHub: [MPCodeWriter21/PDF-To-Image](https://github.com/MPCodeWriter21/PDF-To-Image)
License
-------
This project is licensed under the MIT License.
See the [LICENSE](LICENSE)
References
----------
+ [pypdfium2](https://pypdfium2.readthedocs.io/en/stable/readme.html)
+ [PILlow](https://pillow.readthedocs.io/en/stable/)
+ [log21](https://GitHub.com/MPCodeWriter21/log21)