mkv-episode-matcher 0.1.5__tar.gz → 0.1.10__tar.gz

mkv_episode_matcher-0.1.10/.github/funding.yml

@@ -0,0 +1,2 @@
+github: jsakkos
+buy_me_a_coffee: jsakkos

mkv_episode_matcher-0.1.10/.github/workflows/python-publish.yml

@@ -0,0 +1,52 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mkv-episode-matcher/ # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

{mkv_episode_matcher-0.1.5 → mkv_episode_matcher-0.1.10}/.gitignore

@@ -1,5 +1,8 @@
-*.log
-*.pyc
-*.cpython*
-*.pyc
-/mkv_episode_matcher/__pycache__
+*.log
+*.pyc
+*.cpython*
+*.pyc
+/mkv_episode_matcher/__pycache__
+build/
+dist/
+mkv_episode_matcher.egg-info

mkv_episode_matcher-0.1.10/.readthedocs.yml

@@ -0,0 +1,34 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

{mkv_episode_matcher-0.1.5 → mkv_episode_matcher-0.1.10}/.vscode/settings.json

@@ -1,11 +1,11 @@
-{
-    "python.testing.unittestArgs": [
-        "-v",
-        "-s",
-        "./tests",
-        "-p",
-        "*test*.py"
-    ],
-    "python.testing.pytestEnabled": false,
-    "python.testing.unittestEnabled": true
+{
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "*test*.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true
 }

{mkv_episode_matcher-0.1.5 → mkv_episode_matcher-0.1.10}/PKG-INFO

@@ -1,12 +1,14 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.1
 Name: mkv-episode-matcher
-Version: 0.1.5
+Version: 0.1.10
 Summary: The MKV Episode Matcher is a tool for identifying TV series episodes from MKV files and renaming the files accordingly.
+Home-page: https://github.com/Jsakkos/mkv-episode-matcher
+Author: Jonathan Sakkos
+Author-email: Jsakkos <jonathansakkos@protonmail.com>
+License: MIT
 Project-URL: Documentation, https://github.com/Jsakkos/mkv-episode-matcher#readme
 Project-URL: Issues, https://github.com/Jsakkos/mkv-episode-matcher/issues
 Project-URL: Source, https://github.com/Jsakkos/mkv-episode-matcher
-Author-email: Jsakkos <jonathansakkos@protonmail.com>
-License-Expression: MIT
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
@@ -17,27 +19,34 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.8
-Requires-Dist: configparser
+Description-Content-Type: text/x-rst
+Requires-Dist: requests
 Requires-Dist: loguru
-Requires-Dist: opensubtitlescom
 Requires-Dist: pillow
+Requires-Dist: configparser
+Requires-Dist: tmdb_client
 Requires-Dist: pytesseract
-Requires-Dist: requests
-Requires-Dist: tmdb-client
-Description-Content-Type: text/markdown
+Requires-Dist: opensubtitlescom
 
-# MKV Episode Matcher
- 
-The MKV Episode Matcher is a tool for identifying TV series episodes from MKV files and renaming the files accordingly. 
+===================
+MKV Episode Matcher
+===================
 
-## Quick start
+|docs|  |pypi|
+
+The MKV Episode Matcher is a tool for identifying TV series episodes from MKV files and renaming the files accordingly.
+
+Quick start
+===========
 
 To use the MKV Episode Matcher, follow these steps:
 
-1. Clone this repository `git clone https://github.com/Jsakkos/mkv-episode-matcher`
-1. Obtain an API key from TMDb (https://developers.themoviedb.org/authentication/getting-a-apikey).
-2. (Optional) - Obtain an API key from Opensubtitles.com by creating an API consumer (https://www.opensubtitles.com/en/consumers)
-3. Provide a filepath to your show directory. This is the main directory that contains all of the episodes for a specific show.
+1. Install ``pip install mkv-episode-matcher``
+2. Obtain an API key from TMDb (https://developers.themoviedb.org/authentication/getting-a-apikey).
+3. (Optional) - Obtain an API key from Opensubtitles.com by creating an API consumer (https://www.opensubtitles.com/en/consumers)
+4. Alternatively, add the .srt files to the cache directory. On Windows: ``C:\Users\YOUR_USER_NAME\.mkv-episode-matcher\cache\data\SHOW_NAME``. The files need to be named with the season and episode, e.g. ``Show Name - S01E01.srt``.
+5. Provide a filepath to your show directory. This is the main directory that contains all of the episodes for a specific show.
+
 The directory and subfolders must be arranged in the following structure:
 
 - Show name
@@ -45,33 +54,29 @@ The directory and subfolders must be arranged in the following structure:
   - Season 2
   - ...
   - Season n
-2. Call `python __main__.py` with the TMDB_API_KEY and SHOW_DIR as arguments or in environment variables from your command line:
-
-```
-python __main__.py --api-key `your-api-key` --show-dir /path/to/show
-```
+  
+6. Call ``mkv-match`` with the TMDB_API_KEY and SHOW_DIR as arguments or in environment variables from your command line:
 
-## How it works
+.. code-block:: bash
 
-MKV Episode Matcher extracts the subtitle text from each MKV file, then crossreferences the text against .srt subtitle files that are either user-provided or downloaded from Opensubtitles.com
+   python mkv-match --tmdb-api-key your-api-key --show-dir /path/to/show
 
+Once TMDB_API_KEY is set, there's no need to enter it again, as it gets stored in the config.ini file.
 
-# Contributing
+To get subtitles from opensubtitles.com, ensure that the appropriate credentials have been set, either via the CLI or in config.ini (On Windows: ``C:\Users\YOUR_USER_NAME\.mkv-episode-matcher\config.ini``).
+Then add the ``--get-subs True`` flag to the CLI call
 
-Contributions are welcome! If you would like to contribute to the MKV Episode Matcher project, please follow these steps:
+.. code-block:: bash
 
-1. Fork the repository.
-1. Clone the repository.
-2. Create a new branch for your contribution.
-3. Make your changes and commit them to your branch.
-4. Push your branch to your forked repository.
-5. Open a pull request to the main repository.
+   python mkv-match --show-dir /path/to/show --get-subs True
 
-Please ensure that your code follows the project's coding conventions and standards. Additionally, provide a clear and detailed description of your changes in the pull request.
+How it works
+============
 
-Thank you for your contribution!
+MKV Episode Matcher extracts the subtitle text from each MKV file, then cross-references the text against .srt subtitle files that are either user-provided or downloaded from Opensubtitles.com.
 
-# License
+License
+=======
 
 MIT License
 
@@ -95,6 +100,17 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-# Acknowledgments
+Acknowledgments
+===============
+
 This product uses the TMDB API but is not endorsed or certified by TMDB.
-![The Movie DB Logo](https://www.themoviedb.org/assets/2/v4/logos/v2/blue_long_2-9665a76b1ae401a510ec1e0ca40ddcb3b0cfe45f1d51b77a308fea0845885648.svg)
+
+.. image:: https://www.themoviedb.org/assets/2/v4/logos/v2/blue_long_2-9665a76b1ae401a510ec1e0ca40ddcb3b0cfe45f1d51b77a308fea0845885648.svg
+   :alt: The Movie Database
+   :target: https://www.themoviedb.org/
+
+.. |docs| image:: https://readthedocs.org/projects/mkv-episode-matcher/badge/?version=latest
+   :target: https://mkv-episode-matcher.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+.. |pypi| image:: https://badge.fury.io/py/mkv-episode-matcher.svg
+   :target: https://badge.fury.io/py/mkv-episode-matcher

mkv_episode_matcher-0.1.10/README.rst

@@ -0,0 +1,86 @@
+===================
+MKV Episode Matcher
+===================
+
+|docs|  |pypi|
+
+The MKV Episode Matcher is a tool for identifying TV series episodes from MKV files and renaming the files accordingly.
+
+Quick start
+===========
+
+To use the MKV Episode Matcher, follow these steps:
+
+1. Install ``pip install mkv-episode-matcher``
+2. Obtain an API key from TMDb (https://developers.themoviedb.org/authentication/getting-a-apikey).
+3. (Optional) - Obtain an API key from Opensubtitles.com by creating an API consumer (https://www.opensubtitles.com/en/consumers)
+4. Alternatively, add the .srt files to the cache directory. On Windows: ``C:\Users\YOUR_USER_NAME\.mkv-episode-matcher\cache\data\SHOW_NAME``. The files need to be named with the season and episode, e.g. ``Show Name - S01E01.srt``.
+5. Provide a filepath to your show directory. This is the main directory that contains all of the episodes for a specific show.
+
+The directory and subfolders must be arranged in the following structure:
+
+- Show name
+  - Season 1
+  - Season 2
+  - ...
+  - Season n
+  
+6. Call ``mkv-match`` with the TMDB_API_KEY and SHOW_DIR as arguments or in environment variables from your command line:
+
+.. code-block:: bash
+
+   python mkv-match --tmdb-api-key your-api-key --show-dir /path/to/show
+
+Once TMDB_API_KEY is set, there's no need to enter it again, as it gets stored in the config.ini file.
+
+To get subtitles from opensubtitles.com, ensure that the appropriate credentials have been set, either via the CLI or in config.ini (On Windows: ``C:\Users\YOUR_USER_NAME\.mkv-episode-matcher\config.ini``).
+Then add the ``--get-subs True`` flag to the CLI call
+
+.. code-block:: bash
+
+   python mkv-match --show-dir /path/to/show --get-subs True
+
+How it works
+============
+
+MKV Episode Matcher extracts the subtitle text from each MKV file, then cross-references the text against .srt subtitle files that are either user-provided or downloaded from Opensubtitles.com.
+
+License
+=======
+
+MIT License
+
+Copyright (c) 2024 Jonathan Sakkos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+Acknowledgments
+===============
+
+This product uses the TMDB API but is not endorsed or certified by TMDB.
+
+.. image:: https://www.themoviedb.org/assets/2/v4/logos/v2/blue_long_2-9665a76b1ae401a510ec1e0ca40ddcb3b0cfe45f1d51b77a308fea0845885648.svg
+   :alt: The Movie Database
+   :target: https://www.themoviedb.org/
+
+.. |docs| image:: https://readthedocs.org/projects/mkv-episode-matcher/badge/?version=latest
+   :target: https://mkv-episode-matcher.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+.. |pypi| image:: https://badge.fury.io/py/mkv-episode-matcher.svg
+   :target: https://badge.fury.io/py/mkv-episode-matcher

mkv_episode_matcher-0.1.10/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

mkv_episode_matcher-0.1.10/docs/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: be74ac0df269b49cff07e4148b82b076
+tags: 645f666f9bcd5a90fca523b33c5a78b7

mkv_episode_matcher-0.1.10/docs/_build/html/_sources/api.rst.txt

@@ -0,0 +1,55 @@
+=====================================
+MKV Episode Matcher API Documentation
+=====================================
+
+CLI
+===
+
+.. automodule:: mkv_episode_matcher.__main__
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Utils
+=====
+.. automodule:: mkv_episode_matcher.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+TMDB Interface
+==============
+.. automodule:: mkv_episode_matcher.tmdb_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. py:function:: get_episode_info(show_name, season, episode)
+
+    Get episode information for a given show, season, and episode number.
+
+    :param str show_name: The name of the show.
+    :param int season: The season number.
+    :param int episode: The episode number.
+    :return: A dictionary containing the episode information.
+
+MKV Conversion
+==============
+.. automodule:: mkv_episode_matcher.mkv_to_srt
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Episode Matching
+================
+.. automodule:: mkv_episode_matcher.episode_matcher
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Configuration
+=============
+.. automodule:: mkv_episode_matcher.config
+    :members:
+    :undoc-members:
+    :show-inheritance:

mkv_episode_matcher-0.1.10/docs/_build/html/_sources/generated/mkv_episode_matcher.rst.txt

@@ -0,0 +1,23 @@
+mkv\_episode\_matcher
+=====================
+
+.. automodule:: mkv_episode_matcher
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+

mkv_episode_matcher-0.1.10/docs/_build/html/_sources/index.rst.txt

@@ -0,0 +1,19 @@
+Welcome to MKV Episode Matcher's documentation!
+===============================================
+
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   api
+
+    
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

mkv_episode_matcher-0.1.10/docs/_build/html/_sources/mkv_episode_matcher.rst.txt

@@ -0,0 +1,23 @@
+mkv\_episode\_matcher
+=====================
+
+.. automodule:: mkv_episode_matcher
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+

mkv_episode_matcher-0.1.10/docs/_build/html/_sources/readme.rst.txt

@@ -0,0 +1,7 @@
+.. toctree::
+   :maxdepth: 2
+
+   readme
+
+.. readme:
+.. include:: ../README.rst