vagabondhustler / subsearch

Download subtitles for movies and shows, automatically with one easy mouse click.

Readme Table of Contents

• About
• Preview of GUI
• Install from pypi
• Clone from github
• Install from MSI Package
• Acknowledgements

FAQ Table of Contents

• GUI Options Explained
• Code Analysis and False Positives
• Supported Languages

Misc Table of Contents

• Contributing
• Reporting a Vulnerability

About

Key Features

• Initiate a search for subtitles by simply right-clicking on a media file.
• Search for subtitles in 70 different languages
• Some of the subtitle filters are HI, non-HI, foreign parts only.
• User-friendly GUI for easy customization and configuration
• Available as a compiled executable, source code via GitHub and PyPI
• The setup process is straightforward.

Details

Subsearch is an automated subtitle downloader and extractor with support for many languages. It allows users to search and download subtitles for movies and TV shows with a single click from the context menu. The application features a graphical user interface for configuring options, such as selecting which websites to search on, choosing the subtitle language, applying filters for hearing-impaired, among other options.

Preview

Screenshots of the interface

Installation and usage

Install from pypi:

Requires Python 3.10+

• Install Subsearch by running pip install subsearch in the command prompt.
• Launch the app by running subsearch in the command prompt.

Clone from github

Requires Python *3.10+

• Clone the Subsearch repository by running git clone https://github.com/vagabondHustler/subsearch.git.
• Install Subsearch by running pip install -e . or *pip install -e .[build,lint,tests,tools,type] for optional dependencies.
• Build the executable and MSI installer by running python -m tools.cx_freeze_build bdist_msi.

Important

If you are using Python 3.12+ and cx_Freeze, please refer to this issue.

Windows installer

Requires windows 10/11, probably works on 8.

• Download the windows installer "Subsearch-x.x.x-win64.msi" from here.
• Run the installer.
• If you receive a PUA message, click "More info" → "Run anyway".
• Run Subsearch at least once for all the context menu options to appear

Note

Development builds can be located in the release action job, within the generated artifacts.

Screenshots of PUA message

---

More about potentially unwanted applications (PUA) can be found here on Microsoft's support page.

Acknowledgements

I would like to express my gratitude to the following repositories for providing templates, scripts, inspiration, themes, and solutions to similar problems:

• zavoloklom/material-design-iconic-font // icons
• rdbende/Sun-Valley-ttk-theme // base theme
• TransparentLC // spritesheet_generator.js

subsearch's Issues

[REQUEST] Delete empty sub folder

a great tool, i used to use subliminal as a command in the context menu on windows, but this tool is newer and better.

however is it possible to avoid the creation of the sub folder, or delete it if empty. not sure for what it is needed.

launch error

when I run executable, I get this error:
Traceback (most recent call last):
File "subsearch_main_.py ", line 3, in
File "subsearch_init_.py ", line 114, in main
File "subsearch_init_.py ", line 19, in init
File "subsearch_subsearch_.py ", line 82, in init
File "subsearch\utils\raw_registry.py ", line 131, in add_context_menu
File "subsearch\utils\raw_registry.py ", line 20, in write_keys
FileNotFoundError: [WinError 2] The specified file cannot be found

[REQUEST] Ability to download multiple subtitles at once

[REQUEST] clean up subtitles

FYI, this tool can clean up subtitles. https://github.com/icza/srtgears

maybe the source code is interesting to add this functionality to subsearch too. not high prio.

[REQUEST] - Foreign Only Option

Is your feature request related to a problem? Please describe.
Ability to download only the subtitles that are foreign only
Describe the solution you'd like
Adding a search option to allow for only downloading Foreign only (I know subscene.com has this option as a valid filter)

Describe alternatives you've considered
Downloading the foreign only manually one at a time

Additional context
Add any other context or screenshots about the feature request here.

Implement foreign language-only filter

Originally suggested in Issue #422

Adding a search option to allow for only downloading Foreign only (I know subscene.com has this option as a valid filter)

• #433
• #486
• Implement a foreign language-only filter for yifysubtitles.vip (If possible)

[BUG] FileNotFoundError: [Errno 2] No such file or directory: 'C:\\Users\\mertc\\AppData\\Local\\Subsearch\\config.toml'

Traceback (most recent call last):
  File "C:\Users\mertc\miniconda3\lib\runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "C:\Users\mertc\miniconda3\lib\runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "C:\Users\mertc\miniconda3\Scripts\subsearch.exe\__main__.py", line 7, in <module>
  File "C:\Users\mertc\miniconda3\lib\site-packages\subsearch\utils\decorators.py", line 31, in inner
    return func(*args, **kwargs)
  File "C:\Users\mertc\miniconda3\lib\site-packages\subsearch\__init__.py", line 65, in main
    app = Subsearch()
  File "C:\Users\mertc\miniconda3\lib\site-packages\subsearch\__init__.py", line 20, in __init__
    self.subsearch_core = core.SubsearchCore(PREF_COUNTER)
  File "C:\Users\mertc\miniconda3\lib\site-packages\subsearch\core.py", line 85, in __init__
    Initializer.__init__(self, pref_counter)
  File "C:\Users\mertc\miniconda3\lib\site-packages\subsearch\core.py", line 23, in __init__
    self.setup_file_system()
  File "C:\Users\mertc\miniconda3\lib\site-packages\subsearch\core.py", line 65, in setup_file_system
    io_toml.resolve_on_integrity_failure()
  File "C:\Users\mertc\miniconda3\lib\site-packages\subsearch\utils\io_toml.py", line 77, in resolve_on_integrity_failure
    dump_toml_data(FILE_PATHS.config, DEFAULT_CONFIG)
  File "C:\Users\mertc\miniconda3\lib\site-packages\subsearch\utils\io_toml.py", line 24, in dump_toml_data
    with open(toml_file_path, "w") as f:
FileNotFoundError: [Errno 2] No such file or directory: 'C:\\Users\\mertc\\AppData\\Local\\Subsearch\\config.toml'

how to use the python script as module?

hey, i'm trying to write a python script and would really like to use your script in it,
how to use your script as module and what are the arguments i can pass?

Error when search for "Brazilian-Portuguese" language subtitles

When I run executable, I get this error:

But it only occurs when search for "Brazilian-Portuguese" language, English one works perfectly.

add option to disable `subsearch.log`

Hi, thank you for making this amazing tool

can we have an option to allow user to disable writing logs to a file subsearch.log in every directory?