Skip to content

Latest commit

 

History

History
100 lines (72 loc) · 6.17 KB

README.md

File metadata and controls

100 lines (72 loc) · 6.17 KB

OpenSubtitlesDownload.py

GitHub release GitHub contributors GitHub issues License: GPL v3

Introduction

OpenSubtitlesDownload.py is a small software written in Python, built to help you quickly find and download subtitles for your favorite videos. It can be used as a nautilus script, or as a regular application working under GNOME or KDE desktop environments. You can also use it in full CLI mode (Command Line Interface) on your NAS, Raspberry Pi or anywhere you want really, as long as you have a working Python interpreter.

The subtitles search is done by precisly identifying your video files by computing unique movie hash sums. This way, you have more chance to find the exact subtitles for your videos, avoiding synchronization problems between the subtitles and the soundtrack. But what if that doesn't work? Well, a search with the filename will be performed, but be aware: results are a bit more... unpredictable (don't worry, you will be warned! and you can even disable this feature if you want).

The subtitles search and download service is powered by opensubtitles.org. Big thanks to their hard work on this amazing project! Be sure to give them your support if you appreciate the service provided, they sure need donations for handling the ever growing hosting costs!

Features

  • Use a GNOME/GTK or KDE/Qt GUI depending on your favorite desktop environment
  • Or just use the CLI! Great for automation, and it works on Linux, macOS and Windows
  • Query subtitles in more than 60 different languages for documentaries, movies, TV shows and more...
  • Query subtitles in multiple languages at once
  • Query subtitles for multiple video files and folders at once
  • Detect valid video files (using mime types and file extensions)
  • Detect correct video titles by computing unique movie hash sums in order to download the right subtitles for the right file!
  • If the video detection fails, a backup search using filename is performed
  • Download subtitles automatically if only one is available, choose the one you want otherwise
  • Download the subtitles file right next to the video file (need read/write permissions)
  • Rename downloaded subtitles to match the video file. Possibility to add a language code (ex: movie_en.srt).

Requirements

  • python (version 2 or 3)
  • zenity (only needed for GNOME based desktop environments)
  • kdialog (only needed for KDE based desktop environments)
  • common unix tools (only needed for GUIs): wget & gzip (GUI subtitles downloading), ps & grep (GUI autodetection)

Installation

Quick install as a nautilus script, under GNOME 3 desktop environment:

$ mkdir -p ~/.local/share/nautilus/scripts/
$ cd ~/.local/share/nautilus/scripts/
$ wget https://raw.githubusercontent.com/emericg/OpenSubtitlesDownload/master/OpenSubtitlesDownload.py
$ chmod u+x OpenSubtitlesDownload.py

Use an opensubtitles.org account

Following a recent policy change from opensubtitles.org, the API is now available only for logged users. More informations can be found on this discussion.
If you are concern by this issue, the symptoms are 401 unauthorized error messages. If you try too many times without a valid account, know that your IP address will be banned for 24 H.

To continue using OpenSubtitlesDownload you simply need to:

Website

You can browse the project's website at https://emeric.io/OpenSubtitlesDownload
You can browse the project's GitHub page at https://github.com/emericg/OpenSubtitlesDownload
Learn much more about OpenSubtitlesDownload.py installation and configuration on its wiki at https://github.com/emericg/OpenSubtitlesDownload/wiki

Screenshots!

Start subtitles search

Download selected subtitles

Enjoy your subtitled video! Enjoy your subtitled video!

What if multiple subtitles are available? Just pick one from the list! Multiple subtitles selection

Contributors

  • Emeric Grange emeric.grange@gmail.com maintainer
  • Thiago Alvarenga Lechuga thiagoalz@gmail.com for his work on the 'Windows CLI' and the 'folder search'
  • jeroenvdw for his work on the 'subtitles automatic selection' and the 'search by filename'
  • Gui13 for his work on the arguments parsing
  • Tomáš Hnyk tomashnyk@gmail.com for his work on the 'multiple language' feature
  • Carlos Acedo carlos@linux-labs.net for his work on the original script

License

OpenSubtitlesDownload.py is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
Read the LICENSE file or consult the license on the FSF website directly.

Emeric Grange emeric.grange@gmail.com