Subscleaner
Subscleaner is a Python script that removes advertisements from subtitle files. It's designed to help you enjoy your favorite shows and movies without the distraction of unwanted ads in the subtitles.
Features
- Removes a predefined list of advertisement patterns from subtitle files.
- Supports various subtitle formats through the pysrt library.
- Automatically detects the encoding of subtitle files using chardet.
Installation
Automatic installation
To install with pip:
sudo pip install subscleaner
Manual installation
To install Subscleaner, you'll need Python 3.9 or higher. It's recommended to use Poetry for managing the project dependencies.
- Clone the repository:
git clone https://gitlab.com/rogs/subscleaner.git
- Navigate to the project directory:
cd subscleaner
- Install the dependencies with Poetry:
poetry install
Usage
If you installed the package automatically, you can pipe a list of subtitle filenames into the script:
find /your/media/location -name "*.srt" | subscleaner
If you installed the package manually:
find /your/media/location -name "*.srt" | poetry run subscleaner
Alternatively, you can use the script directly if you've installed the dependencies globally:
find /your/media/location -name "*.srt" | python3 subscleaner.py
Contributing
Contributions are welcome! If you have any suggestions or improvements, feel free to fork the repository and submit a pull request.
License
Subscleaner is licensed under the GNU General Public License v3.0 or later. See the LICENSE file for more details.
Acknowledgments
This repository is a rewrite of this Github repository: https://github.com/FraMecca/subscleaner.
Thanks to FraMecca in Github!