Subsearch


NameSubsearch JSON
Version 2.46.0 PyPI version JSON
download
home_pageNone
SummarySubsearch
upload_time2024-05-15 13:31:38
maintainerNone
docs_urlNone
authorvagabondHustler
requires_python>=3.12
licenseMIT license
keywords subtitles sub srt tool tools download movies shows scrape opensubtitles subscene subsearch subtitles yifysubtitles
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center"><img src="https://raw.githubusercontent.com/vagabondHustler/SubSearch/main/assets/subsearch_v2.png"/></h1>

<div align="center">

![tests](https://img.shields.io/github/actions/workflow/status/vagabondhustler/subsearch/ci.yml?style=flat-square&labelColor=1e1e2e&label=ci)
![github_commit_activity](https://img.shields.io/github/last-commit/vagabondhustler/subsearch?&style=flat-square&labelColor=1e1e2e&label=commit%20activity)
![python_version](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FvagabondHustler%2Fsubsearch%2Fmain%2Fpyproject.toml&style=flat-square&labelColor=1e1e2e)
![release](https://img.shields.io/github/v/tag/vagabondhustler/subsearch?style=flat-square&labelColor=1e1e2e&label=latest%20release)
![downloads-total)](https://img.shields.io/github/downloads/vagabondhustler/subsearch/total?style=flat-square&labelColor=%231e1e2e&label=downloads)
![license](https://img.shields.io/github/license/vagabondhustler/subsearch?&style=flat-square&labelColor=1e1e2e)

</div>

#### Readme Table of Contents

- [About](#about)
- [Preview of GUI](#preview)
- [Install from pypi](#pypi)
- [Clone from github](#clone)
- [Install from MSI Package](#msi)
- [Acknowledgements](#thanks)

#### FAQ Table of Contents

- [GUI Options Explained](https://github.com/vagabondHustler/subsearch/discussions/556)
- [Code Analysis and False Positives](https://github.com/vagabondHustler/subsearch/discussions/557)
- [Supported Languages](https://github.com/vagabondHustler/subsearch/discussions/558)

#### Misc Table of Contents

- [Contributing](https://github.com/vagabondHustler/SubSearch/blob/main/.github/CONTRIBUTING.md)
- [Reporting a Vulnerability](https://github.com/vagabondHustler/SubSearch/blob/main/.github/SECURITY.md)

## About <a name = "about"></a>

#### 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](https://github.com/vagabondHustler/subsearch/discussions/558). 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](https://github.com/vagabondHustler/subsearch/discussions/556).

## Preview <a name = "preview"></a>

<div align="center">

![prtsc_example](https://raw.githubusercontent.com/vagabondHustler/SubSearch/main/assets/example.gif)

<details>
<summary>Screenshots of the interface</summary>

![prtsc_language](https://github.com/vagabondHustler/subsearch/blob/main/assets/language_options.png?raw=true)

![prtsc_search](https://github.com/vagabondHustler/subsearch/blob/main/assets/search_filters.png?raw=true)

![prtsc_settings](https://github.com/vagabondHustler/subsearch/blob/main/assets/subsearch_options.png?raw=true)

![prtsc_download](https://github.com/vagabondHustler/subsearch/blob/main/assets/download_manager.png?raw=true)

</details>

</div>

## Installation and usage <a name = "getting_started_src"></a>

#### Install from pypi: <a name = "pypi"></a>

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

#### Clone from github <a name = "clone"></a>

- 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`.

#### Windows installer <a name = "msi"></a>

Requires windows 10/11, probably works on 8.

- Download the windows installer "Subsearch-x.x.x-win64.msi" from [here](https://github.com/vagabondHustler/subsearch/releases).
- 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

###### Development builds can be located in the [release](https://github.com/vagabondHustler/subsearch/actions/workflows/release.yml) action job, within the generated artifacts.

<details>
<summary>Screenshots of PUA message<a name = "pua"></a></summary>

![prtsc_moreinfo](https://raw.githubusercontent.com/vagabondHustler/SubSearch/main/assets/moreinfo.png)

![prtsc_runanyway](https://raw.githubusercontent.com/vagabondHustler/SubSearch/main/assets/runanyway.png)

---

</details>

More about potentially unwanted applications (PUA) can be found [here](https://support.microsoft.com/en-us/windows/protect-your-pc-from-potentially-unwanted-applications-c7668a25-174e-3b78-0191-faf0607f7a6e) on Microsoft's support page.

## Acknowledgements<a name = "thanks"></a>

The following repositories provided templates, scripts, inspiration, themes, etc:

- [zavoloklom/material-design-iconic-font](https://github.com/zavoloklom/material-design-iconic-font) // icons
- [rdbende/Sun-Valley-ttk-theme](https://github.com/rdbende/Sun-Valley-ttk-theme) // base theme
- [TransparentLC](https://github.com/TransparentLC) // spritesheet_generator.js

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "Subsearch",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "subtitles, sub, srt, tool, tools, download, movies, shows, scrape, opensubtitles, subscene, subsearch, subtitles, yifysubtitles",
    "author": "vagabondHustler",
    "author_email": "vagabondHustler.github@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/1a/07/90f60bd68d82928f00a0caf36478a6c0fddfe4004a27b12910c643f73f90/subsearch-2.46.0.tar.gz",
    "platform": "win32",
    "description": "<h1 align=\"center\"><img src=\"https://raw.githubusercontent.com/vagabondHustler/SubSearch/main/assets/subsearch_v2.png\"/></h1>\r\n\r\n<div align=\"center\">\r\n\r\n![tests](https://img.shields.io/github/actions/workflow/status/vagabondhustler/subsearch/ci.yml?style=flat-square&labelColor=1e1e2e&label=ci)\r\n![github_commit_activity](https://img.shields.io/github/last-commit/vagabondhustler/subsearch?&style=flat-square&labelColor=1e1e2e&label=commit%20activity)\r\n![python_version](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FvagabondHustler%2Fsubsearch%2Fmain%2Fpyproject.toml&style=flat-square&labelColor=1e1e2e)\r\n![release](https://img.shields.io/github/v/tag/vagabondhustler/subsearch?style=flat-square&labelColor=1e1e2e&label=latest%20release)\r\n![downloads-total)](https://img.shields.io/github/downloads/vagabondhustler/subsearch/total?style=flat-square&labelColor=%231e1e2e&label=downloads)\r\n![license](https://img.shields.io/github/license/vagabondhustler/subsearch?&style=flat-square&labelColor=1e1e2e)\r\n\r\n</div>\r\n\r\n#### Readme Table of Contents\r\n\r\n- [About](#about)\r\n- [Preview of GUI](#preview)\r\n- [Install from pypi](#pypi)\r\n- [Clone from github](#clone)\r\n- [Install from MSI Package](#msi)\r\n- [Acknowledgements](#thanks)\r\n\r\n#### FAQ Table of Contents\r\n\r\n- [GUI Options Explained](https://github.com/vagabondHustler/subsearch/discussions/556)\r\n- [Code Analysis and False Positives](https://github.com/vagabondHustler/subsearch/discussions/557)\r\n- [Supported Languages](https://github.com/vagabondHustler/subsearch/discussions/558)\r\n\r\n#### Misc Table of Contents\r\n\r\n- [Contributing](https://github.com/vagabondHustler/SubSearch/blob/main/.github/CONTRIBUTING.md)\r\n- [Reporting a Vulnerability](https://github.com/vagabondHustler/SubSearch/blob/main/.github/SECURITY.md)\r\n\r\n## About <a name = \"about\"></a>\r\n\r\n#### Key Features\r\n  \r\n- Initiate a search for subtitles by simply right-clicking on a media file.\r\n- Search for subtitles in 70 different languages\r\n- Some of the subtitle filters are HI, non-HI, foreign parts only.\r\n- User-friendly GUI for easy customization and configuration\r\n- Available as a compiled executable, source code via GitHub and PyPI\r\n- The setup process is straightforward.\r\n\r\n#### Details\r\n\r\nSubsearch is an automated subtitle downloader and extractor with support for many [languages](https://github.com/vagabondHustler/subsearch/discussions/558). 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](https://github.com/vagabondHustler/subsearch/discussions/556).\r\n\r\n## Preview <a name = \"preview\"></a>\r\n\r\n<div align=\"center\">\r\n\r\n![prtsc_example](https://raw.githubusercontent.com/vagabondHustler/SubSearch/main/assets/example.gif)\r\n\r\n<details>\r\n<summary>Screenshots of the interface</summary>\r\n\r\n![prtsc_language](https://github.com/vagabondHustler/subsearch/blob/main/assets/language_options.png?raw=true)\r\n\r\n![prtsc_search](https://github.com/vagabondHustler/subsearch/blob/main/assets/search_filters.png?raw=true)\r\n\r\n![prtsc_settings](https://github.com/vagabondHustler/subsearch/blob/main/assets/subsearch_options.png?raw=true)\r\n\r\n![prtsc_download](https://github.com/vagabondHustler/subsearch/blob/main/assets/download_manager.png?raw=true)\r\n\r\n</details>\r\n\r\n</div>\r\n\r\n## Installation and usage <a name = \"getting_started_src\"></a>\r\n\r\n#### Install from pypi: <a name = \"pypi\"></a>\r\n\r\n- Install Subsearch by running `pip install subsearch` in the command prompt.\r\n- Launch the app by running `subsearch` in the command prompt.\r\n\r\n#### Clone from github <a name = \"clone\"></a>\r\n\r\n- Clone the Subsearch repository by running `git clone https://github.com/vagabondHustler/subsearch.git`.\r\n- Install Subsearch by running `pip install -e .` or *`pip install -e .[build,lint,tests,tools,type]` for optional dependencies.\r\n- Build the executable and MSI installer by running `python -m tools.cx_freeze_build bdist_msi`.\r\n\r\n#### Windows installer <a name = \"msi\"></a>\r\n\r\nRequires windows 10/11, probably works on 8.\r\n\r\n- Download the windows installer \"Subsearch-x.x.x-win64.msi\" from [here](https://github.com/vagabondHustler/subsearch/releases).\r\n- Run the installer.\r\n- If you receive a PUA message, click \"More info\" \u2192 \"Run anyway\".\r\n- Run Subsearch at least once for all the context menu options to appear\r\n\r\n###### Development builds can be located in the [release](https://github.com/vagabondHustler/subsearch/actions/workflows/release.yml) action job, within the generated artifacts.\r\n\r\n<details>\r\n<summary>Screenshots of PUA message<a name = \"pua\"></a></summary>\r\n\r\n![prtsc_moreinfo](https://raw.githubusercontent.com/vagabondHustler/SubSearch/main/assets/moreinfo.png)\r\n\r\n![prtsc_runanyway](https://raw.githubusercontent.com/vagabondHustler/SubSearch/main/assets/runanyway.png)\r\n\r\n---\r\n\r\n</details>\r\n\r\nMore about potentially unwanted applications (PUA) can be found [here](https://support.microsoft.com/en-us/windows/protect-your-pc-from-potentially-unwanted-applications-c7668a25-174e-3b78-0191-faf0607f7a6e) on Microsoft's support page.\r\n\r\n## Acknowledgements<a name = \"thanks\"></a>\r\n\r\nThe following repositories provided templates, scripts, inspiration, themes, etc:\r\n\r\n- [zavoloklom/material-design-iconic-font](https://github.com/zavoloklom/material-design-iconic-font) // icons\r\n- [rdbende/Sun-Valley-ttk-theme](https://github.com/rdbende/Sun-Valley-ttk-theme) // base theme\r\n- [TransparentLC](https://github.com/TransparentLC) // spritesheet_generator.js\r\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "Subsearch",
    "version": "2.46.0",
    "project_urls": {
        "repository": "https://github.com/vagabondHustler/subsearch"
    },
    "split_keywords": [
        "subtitles",
        " sub",
        " srt",
        " tool",
        " tools",
        " download",
        " movies",
        " shows",
        " scrape",
        " opensubtitles",
        " subscene",
        " subsearch",
        " subtitles",
        " yifysubtitles"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8c1d360d098b9e1e2572667d392a278379343040b07919840d4ddcd505908893",
                "md5": "04023520d9eab02f3f59be2dfc5e2ba2",
                "sha256": "a69e1421832ead048b2c16e48660e95b5e535d666f2239b2ef30e69c34da8b8e"
            },
            "downloads": -1,
            "filename": "Subsearch-2.46.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "04023520d9eab02f3f59be2dfc5e2ba2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 68502,
            "upload_time": "2024-05-15T13:31:35",
            "upload_time_iso_8601": "2024-05-15T13:31:35.327144Z",
            "url": "https://files.pythonhosted.org/packages/8c/1d/360d098b9e1e2572667d392a278379343040b07919840d4ddcd505908893/Subsearch-2.46.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1a0790f60bd68d82928f00a0caf36478a6c0fddfe4004a27b12910c643f73f90",
                "md5": "6e29be22b81d61d749ebb033a25c679c",
                "sha256": "6d3b5b23753fb81bd1ac8915d9ef3b4355077ceeea0cb0d0e44da7ebf3ae7a0d"
            },
            "downloads": -1,
            "filename": "subsearch-2.46.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6e29be22b81d61d749ebb033a25c679c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 58366,
            "upload_time": "2024-05-15T13:31:38",
            "upload_time_iso_8601": "2024-05-15T13:31:38.055864Z",
            "url": "https://files.pythonhosted.org/packages/1a/07/90f60bd68d82928f00a0caf36478a6c0fddfe4004a27b12910c643f73f90/subsearch-2.46.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-15 13:31:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vagabondHustler",
    "github_project": "subsearch",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "subsearch"
}
        
Elapsed time: 5.04666s