yosi-dediashvili / subit

Subtitles downloading, the right (click) way.

Notice

The development of SubiT has currently stopped by my side. Feel free to contribute to the project. With that said, i'll try to respond to emails and such.

#Our site: http://subit-app.sf.net

SubiT is an automated program for downloading subtitles.

This is how the main window of the program looks under Windows 7:

First of all, feel free to contact us with any problem at: http://www.subit-app.sf.net/contact.html

##Download: SubiT's compiled files are stored in Sourceforge.

##Develop: SubiT is written in python, with one exception which is the ContextMenuHandler (for Windows) that was written in c++.

##Usage:

###For Windows users: It's recommended that you will use the win32 setup file of SubiT in order to perform the installation. However, if you refuse to do so, follow these steps:

How To Install: 
	1. Extract files from the zip archive
	2. For right click association, Click Start->Run->Cmd, and type in the location of SubiT.exe 
	   file and pass it the -associate param, i.e. "SubiT.exe -associate" (without the quotes)
	3. Use right click on a movie/ TV show or just run SubiT.exe

How To Uninstall:
	1. For right click association, Click Start->Run->Cmd, and type in the location of SubiT.exe 
	   file and pass it the -unassociate param, i.e. "SubiT.exe -unassociate" (without the quotes)
	2. Delete SubiT's folder

*NOTE: If the right click menu doesn't work (complains about missing file or something like that), Execute 
SubiT and go to Settings->Context Menu, and uncheck the "Associate extensions" check box, click apply, and
recheck the checkbox, and finally, click Apply.

###For Linux users: 1. Grab SubiT's source files. 2. Install the dependencies specified in "SubiTSdk/Dependencies.txt" 3. Execute SubiTProxy.py under the src directory.

###For OSX users: From minor check that we made, SubiT is capable of running under OSX after the PySide module is installed on the System. We currently not supporting OSX. Contact us if you're interested on running SubiT under apple's OS.

###Using SubiT in Command Line mode (CLI):

After several requests for cli mode in SubiT, we added this feature in version 2.0.0. To activate it, 
you need to manually edit the config.ini file of SubiT (located under SubiTs folder, in the Settings 
directory). The relevant key in the configuration is the Global.interaction_type.

In order to apply gui, set the value to 0.
In order to apply silent gui mode, set the value to 1 (won't work, set for future implementation).
In order to apply cli, set the value to 2.
In order to apply silent cli mode, set the value to 3 (Probably won't work that good).

Launch SubiT as usual.

##Changelog:

• Version 2.2.5 -

  • Updated several providers due to changes performed in the sites (www.addic7ed.com, www.subscene.com and SubsCenter).

• Version 2.2.4 -

  • Added Bulgarian language support for www.subscene.com, www.addic7ed.com and www.opensubtitles.com

• Version 2.2.3 -

  • Added Arabic support for www.subscene.com
  • Fixed www.subtitle.co.il provider
  • Fixed www.addic7ed.com provider

• Version 2.2.2 -

  • Fixed minor bug when associating SubiT with ContextMenu when SubiT is placed in a None-English path

• Version 2.2.1 -

  • Fixed Subscenter's provider

• Version 2.2.0 -

  • Added support for www.subscene.com
  • Added fake subtitle check to Torec's provider (we'll no longer download the fake subtitles)
  • Fixed SubsCenter's provdier
  • Improved the logic in Addic7ed's provider (Distinguish between serieses and movies results)
  • Added more languages (Spanish, Turkish, Slovak and Czech)
  • Added Unit Testing for the SubProviders
  • Fixed compilation scripts so they do not contain staic paths
  • Search line is kept after the subtitle is downloaded
  • Close on finish is set to False by default

• Version 2.1.2 -

  • Fixed Torec's and Subtitle's providers.

• Version 2.1.0 -

  • Use argparse to parse the arugments
  • Save the last window size (when the program closes) for the next program startup
  • Remember the visibility of the log window
  • Add option to select between startup point of center screen or mouse position
  • Add option (in config) to simply use all the providers (instead of choosing them all)
  • Fix empty result returned by Addic7ed's provider
  • Return Win32_Error to notify failure in download
  • Distribute SubiT with no language selected
  • Create new Context Menu for windows platform
  • Adjust latin numbering for the ranking functions
  • Fix TorecProvider blocking
  • Create a new SubFlow.
  • Put movie name in the textbox when it's past as a parameter to SubiT

• Version 2.0.2 (Linux only) -

  • Major bug fix in SubiT's console mode

• Version 2.0.1 -

  • Critical Bug fix in the ranking functions
  • Edge case Bug fix in movie name formatting function
  • Bug fix in the update notification

• Version 2.0.0 -

  • New head version!
  • Major GUI improvments and changes
  • Added support for www.addic7ed.com
  • Movie file drop to SubiT's main window is now supported
  • Added support for default download location
  • Improved log messages
  • Subtitles selection flow improved
  • Subtitles Ranking function improved
  • Improved provider selection (both language and site)
  • Fixed update mechanizm
  • Privilage elevation is requested when performing right-click association in none Admin account (under Windows)
  • Crashing fixed completely

• Version 1.3.1 -

  • Added support for primary and secondary language subtitles search
  • Removed auto-update feature (the feature will return on later version)
  • Improved function for subtitles versions ranking
  • Added support for Linux (Checked under ununtu)
  • Right-click registration problem - Fixed (still need to run as administrator for registration)
  • Changed www.sratim.co.il handler to work with the latest changes on the site
  • Changed www.torec.net handler to work with the latest changes on the site
  • Fixed several minor bugs

• Version 1.3.0 -

  • Added full support for www.sratim.co.il
  • Added full support for www.subscenter.org
  • Added upate mechanizm (AutoUpdate&Update notification)
  • Using www.OpenSubtitles.org's file hash&name data to identify movies (and serieses)
  • Moved to unified configuration file and better settings window
  • Enabled auto-close on finish

• Version 1.2.0 -

  • Added support to www.subscenter.org subtitles (Movies only)
  • Added restart options in settings windows
  • Fixed crashing problems

• Version 1.1.0 -

  • Added support to www.OpenSubtitles.org subtitle services Added support for selecting different subtitle handler
  • Gui Improvments

• Version 1.0.0 -

  • Bug fix and new features

• Version 0.9.9 -

  • Initial release

--==Special thanks to www.OpenSubtitles.org for delivering their API==--

subit's Issues

Extend each provider supported language to include all the site's supported language

opensubtitles already has a lot of portuguese subtitiles, is there any way to activate language "Portuguese" on subit?

Improvements to the normalization module

We need to add another normalization method that concatenates words from the title. The new method will come right after the 2nd normalization, and for will:

• For each pair of words (as a sliding windows) splitted by underscore _, concatenate them, and define it as normalized string
  • For each normalized string, we'll apply the 3rd and 4th normalization method

This step will actually return a list of normalized strings and not a single ont.

The RequestsManager

The providers module

Including the factory, the MainProvider and everything else.

• MainProvider
• Providers factory

Providers

• OpenSubtitles
• Addic7ed
• Torec
• Subscenter
• Subtitles (Ktuvit)
• Subscene

Languages that will be supported

• Hebrew
• English
• Spanish
• Arabic
• Bulgarian
• Slovak
• Turkish
• Czech
• Russian
• Norwegian
• Swedish
• French
• Greek
• Portuguese
• Croatian
• Romanian
• Catalan

Add caching to the OpenSubtitlesServer

We can introduce caching responses quite simply.

French providers

Add support for the following french providers:

• www.subsynchro.com
• www.subtitlesbank.com
• www.tvsubtitles.net
• www.podnapisi.net

The Title object

Including the MovieTitle and SeriesTitle objects.

GUI redesign

In order to design the GUI correctly, we first need to define the use cases for SubiT.

The user:

1. Opens the program directly with no parameters, and drags / browse one or more files/directories.
2. Opens the program directly, and enters a free query
3. Fires up the program via the context menu or CommandLine with one ore more files/directories.

In any of the cases, the user might decide to:

1. Cancel the download for one or more files.
2. Perform a manual selection of the right subtitle for a given file.
3. Decide/be asked to supply an alternative query for file/query.
4. Most importantly: Enter one or more additional files/directories/queries.

Based on these use cases, the new GUI should supply the following:

1. Some sort of list-based results (row for each query)
2. Upper part with the ability to enter a free query or select/drag files/directories
3. The rows portion will allow dragging of files/directories
4. Each row will supply functionalities as: [Cancel, Change, Manual etc...]
5. A progress bar that will show us where are we in the flow of selecting a version
6. Some sort of notification mechanism, that will notify the user that we need his help in selecting the right version etc...

• Allow Draging of directories to the programs's window
• Show full status after running on folders
• Add Always-On-Top option

Expose subtitle file naming schemes

Allow the user to specify the format for the name of the subtitles.
We should use the same format as python's string format scheme.

*It might be nice to implement the configuration of such thing as dragable objects that can be concatenated.

The Version object

Including the ProviderVersion.

The SubiTAPI object

The last object to be implemented in the API.

The TitleVersions object

Define configuration path that is accessible in any user level or different installation directory

At the moment SubiT needs and administrator rights since it's config files are in "programs files". we should move them to %appdata% for windows and use a "." folder in linux
Also, we should allow the user to select where will SubiT be installed

Add right click option in Linux

Gnome 2/3
KDE
Xface

Add support for the thesubdb.com

They have a nice API: http://thesubdb.com/api/

Allow different installation directory

Depends on the new path of the configuration.

Upgrade to QT5

Swedish Providers

Add a Swedish provider to SubiT:

• www.undertexter.se

Use enzyme module for identifiers extraction

Turns out that there's this cool python module: https://github.com/Diaoul/enzyme

We should use it in order to extract identifiers for files in case we were provided will full paths to files.

Any chance to add Croatian language?

Hi guys,
great app! Any chance to add a Croatian language to the SubiT App?
Thanks!

The title discovery module

The name normalization module

Add a debug module

We need to add some kind of debug module to the new subit api.
it should replace the old WriteDebug from utils.py
see: https://github.com/subit/SubiT/blob/master/src/Utils.py#L626

Bulgarian providers

Two sites:

• www.subs.sab.bz
• www.subsunacs.net

There's some info about them in the mailbox.

Downloading the subtitles for the wrong season

Instead of downloading the subtitles for an episode from season 3 of a show, it's downloading the subtitles of the right episode, but from season 1.

Distinguish between "hearing impaired" and "regular" subtitles

We would like the ability the distinguish between the two, and also provide the option to the disable the download of one of them.

The Identifiers extraction module

Remove the AutoUpdate module

It takes too much time to maintain such feature.

Instead, there should be a mechanism for notifying about new versions.

The Input object

The subtitle deployment module

Add option to watch folder