Ad removal tool for PDFs written in python.
Project description
Gulag Cleaner
Gulag Cleaner is a tool designed to remove advertisements from PDFs, making it easier to read and navigate documents without being disrupted by unwanted ads.
This tool does not just crop the ads out of the PDF, instead, we extract the original file without ads by manipulating the internal structure of the PDF, ensuring maximum quality.
In addition to removing advertisements, Gulag Cleaner is also capable of extracting metadata, such as the author, subject, university, and more, from the file.
Web Version
This tool can be used without installation directly from our website (in Spanish).
Installation
To install Gulag Cleaner, please download and install Python and then run the following command in your terminal:
pip install gulagcleaner
Usage
Gulag Cleaner can be used through both a Command Line Interface (CLI) and in your code.
Command Line Interface
To use Gulag Cleaner through the CLI, simply run the following command, replacing <filename>
with the name of your PDF file:
gulagcleaner [-r] [-h] [-o] [-v] <filename>
Options
Gulag Cleaner provides several options for its usage:
- '-r': Replace the original file with the cleaned version.
- '-o': Use the old cleaning method (for files older than 18/05/2023).
- '-h': Display the help message, providing information on how to use Gulag Cleaner.
- '-v': Display the current version of Gulag Cleaner.
Code
To use Gulag Cleaner in your code, you can use the following code snippet:
from gulagcleaner.extract import clean_pdf
return_msg = clean_pdf("file.pdf")
License
Gulag Cleaner is distributed under the GPL-3 license, which means it's open-source and free to use.
Contributing
We're always looking for ways to improve Gulag Cleaner, and we welcome contributions from the community. If you have ideas for improvements or bug fixes, please feel free to submit a pull request.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gulagcleaner-0.6.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0772094b040124168400a3f728882c806fc9be9b53b30d4387c4d1d2a3f0c0a0 |
|
MD5 | b90087c830361f0ca3ff7f950482b64b |
|
BLAKE2b-256 | 2c0672c9f0bcc4f6a0677dffd5b411094c74a33db8899588484ea0c166904e75 |