mkv-episode-matcher 0.1.4__py3-none-any.whl → 0.1.9__py3-none-any.whl

{mkv_episode_matcher-0.1.4.dist-info → mkv_episode_matcher-0.1.9.dist-info}/METADATA

@@ -1,12 +1,14 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.1
 Name: mkv-episode-matcher
-Version: 0.1.4
+Version: 0.1.9
 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: pytesseract
-Requires-Dist: requests
+Requires-Dist: configparser
 Requires-Dist: tmdb-client
-Description-Content-Type: text/markdown
+Requires-Dist: pytesseract
+Requires-Dist: opensubtitlescom
+
+===================
+MKV Episode Matcher
+===================
 
-# MKV Episode Matcher
- 
-The MKV Episode Matcher is a tool for identifying TV series episodes from MKV files and renaming the files accordingly. 
+|docs|  |pypi|
 
-## Quick start
+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:
+  
+6. Call ``mkv-match`` 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
-```
+.. code-block:: bash
 
-## How it works
+   python mkv-match --tmdb-api-key your-api-key --show-dir /path/to/show
 
-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
+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
 
-# Contributing
+.. code-block:: bash
 
-Contributions are welcome! If you would like to contribute to the MKV Episode Matcher project, please follow these steps:
+   python mkv-match --show-dir /path/to/show --get-subs True
 
-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.
+How it works
+============
 
-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.
+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.
 
-Thank you for your contribution!
-
-# 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.9.dist-info/RECORD

@@ -0,0 +1,25 @@
+mkv_episode_matcher/.gitattributes,sha256=Gh2-F2vCM7SZ01pX23UT8pQcmauXWfF3gwyRSb6ZAFs,66
+mkv_episode_matcher/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+mkv_episode_matcher/__main__.py,sha256=qCd7iLsmg25JIoSd8Gos7w5c1iAlgyyXc3KyXKF0ThE,6809
+mkv_episode_matcher/config.py,sha256=zDDKBcsDt5fME9BRqiTi7yWKeast1pZh36BNYMvIBYM,2419
+mkv_episode_matcher/episode_matcher.py,sha256=UBT53tiC0xryl9k9XXoRUY1-08u5DH-NcwnmD-MSWG8,8914
+mkv_episode_matcher/mkv_to_srt.py,sha256=m34nhgiBSBGpymePUt2C-EmGhcjoXnv3S0SLod-DkFo,6092
+mkv_episode_matcher/requirements.txt,sha256=76Vnmjv4R08bmjbaAu8Kbl0ogyT7MBdVPprBegxc4Uk,76
+mkv_episode_matcher/tmdb_client.py,sha256=LbMCgjmp7sCbrQo_CDlpcnryKPz5S7inE24YY9Pyjk4,4172
+mkv_episode_matcher/utils.py,sha256=Jc0_sn_UG-n_sQ-oLQqMhFuU2QmNiU1iNb8sfd8ljEw,9439
+mkv_episode_matcher/libraries/pgs2srt/.gitignore,sha256=mt3uxWYZaFurMw_yGE258gWhtGKPVR7e3Ll4ALJpyj4,23
+mkv_episode_matcher/libraries/pgs2srt/README.md,sha256=olb25G17tj0kxPgp_LcH5I2QWXjgP1m8JFyjYRGz4UU,1374
+mkv_episode_matcher/libraries/pgs2srt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkv_episode_matcher/libraries/pgs2srt/imagemaker.py,sha256=w5YMWU70TPf7bjbVUcXBIagBMR4mz0uXqHdjLO1GQlY,2733
+mkv_episode_matcher/libraries/pgs2srt/pgs2srt.py,sha256=miKviiKRlN7h2tkbV-3twyjUzVnXWbWZPYEaLy-wKdo,4162
+mkv_episode_matcher/libraries/pgs2srt/pgsreader.py,sha256=bFlaPYzUs9H9qZ5JEE53YmP08yma2c59aLQBNzAgz_c,6948
+mkv_episode_matcher/libraries/pgs2srt/requirements.txt,sha256=sg87dqWw_qpbwciw-Mc5mRJnV9LaCni2cybnT5ANqnA,59
+mkv_episode_matcher/libraries/pgs2srt/Libraries/SubZero/SubZero.py,sha256=1ZXUENOTxK4u9dBNTwnjrd-GRE-WHf-yi2LBainSwRw,9869
+mkv_episode_matcher/libraries/pgs2srt/Libraries/SubZero/post_processing.py,sha256=KZgMDCLPSfnDbbC9myvg1znkjapO0iSp7z_mIxf2e5k,9742
+mkv_episode_matcher/libraries/pgs2srt/Libraries/SubZero/dictionaries/data.py,sha256=GpbuAVy8IPX7KRqKUuhToJuUVqhASg_Phw_6j8KJN6g,676580
+mkv_episode_matcher/notebooks/get_subtitles_test.ipynb,sha256=7dku1ttsUB96R_7RVhSKAlbMfuJsOxkXAtFgJUwVqqc,8031
+mkv_episode_matcher-0.1.9.dist-info/METADATA,sha256=iGAQrvTFgiqQKiNfHEW0-NvJ6GMN8DrjxdB5LxLn8lw,4964
+mkv_episode_matcher-0.1.9.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+mkv_episode_matcher-0.1.9.dist-info/entry_points.txt,sha256=IglJ43SuCZq2eQ3shMFILCkmQASJHnDCI3ogohW2Hn4,64
+mkv_episode_matcher-0.1.9.dist-info/top_level.txt,sha256=XRLbd93HUaedeWLtkyTvQjFcE5QcBRYa3V-CfHrq-OI,20
+mkv_episode_matcher-0.1.9.dist-info/RECORD,,

{mkv_episode_matcher-0.1.4.dist-info → mkv_episode_matcher-0.1.9.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.24.2
+Generator: setuptools (72.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

mkv_episode_matcher-0.1.9.dist-info/top_level.txt

@@ -0,0 +1 @@
+mkv_episode_matcher

mkv_episode_matcher/libraries/pgs2srt/.git

@@ -1 +0,0 @@
-gitdir: ../../.git/modules/libraries/pgs2srt

mkv_episode_matcher-0.1.4.dist-info/RECORD

@@ -1,24 +0,0 @@
-mkv_episode_matcher/.gitattributes,sha256=Gh2-F2vCM7SZ01pX23UT8pQcmauXWfF3gwyRSb6ZAFs,66
-mkv_episode_matcher/__init__.py,sha256=7OebbR9ptXEJ-La95bk1Pl5FALlPEv5hER0ClOKCl_o,19
-mkv_episode_matcher/__main__.py,sha256=UW2-p_vhGCSlimKdVlpf-5mRR5_VIbIuZXB_Q9RXNGA,6672
-mkv_episode_matcher/config.py,sha256=zDDKBcsDt5fME9BRqiTi7yWKeast1pZh36BNYMvIBYM,2419
-mkv_episode_matcher/episode_matcher.py,sha256=UBT53tiC0xryl9k9XXoRUY1-08u5DH-NcwnmD-MSWG8,8914
-mkv_episode_matcher/mkv_to_srt.py,sha256=r7l4WD6XySuRusNKYStDsTHINj3lO_LoqncN39muek0,6266
-mkv_episode_matcher/requirements.txt,sha256=0JLuUm69lLp8anUgtW48CuULZ_lSwd-1XL3eoShVWjI,93
-mkv_episode_matcher/tmdb_client.py,sha256=LbMCgjmp7sCbrQo_CDlpcnryKPz5S7inE24YY9Pyjk4,4172
-mkv_episode_matcher/utils.py,sha256=UMygaE4ZUvV9BRyXxmgfd1g06-0pk1eGlM56NzfgjYM,9305
-mkv_episode_matcher/libraries/pgs2srt/.git,sha256=-NzRRkakNIcN-_2R531WlezRY3CRFyRUhM6YUeQjZko,45
-mkv_episode_matcher/libraries/pgs2srt/.gitignore,sha256=1QVFkpoo1FvhvZ_fs3W7nwO0CAxbY1-CHiQr4fmHaCc,25
-mkv_episode_matcher/libraries/pgs2srt/README.md,sha256=8uf4oJMIs_FmXZ7CE9U6mRgUFULR8hylbpeqfGd5PrI,1400
-mkv_episode_matcher/libraries/pgs2srt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkv_episode_matcher/libraries/pgs2srt/imagemaker.py,sha256=TCzV8q4q-VSGW9weLF9wG4-1mzs7a_HCDsKkbzvNh-k,2820
-mkv_episode_matcher/libraries/pgs2srt/pgs2srt.py,sha256=hKpCx-w3G0XROBgVS4pqMWGSinnKf4Kd-TZjWpCFuk4,4283
-mkv_episode_matcher/libraries/pgs2srt/pgsreader.py,sha256=JhQ4ml0zquSBN6FxvyyDNDugSexKzhGkUwxunVHYm3A,7169
-mkv_episode_matcher/libraries/pgs2srt/requirements.txt,sha256=pfVCz2C3a0Fn98iRCZiWpY4uBFj3gwB1_r-xyAxX-rM,63
-mkv_episode_matcher/libraries/pgs2srt/Libraries/SubZero/SubZero.py,sha256=-7ZiNeqrS7beaBKRvxnPqN6cjRttKmpu9EyEgIyk4wc,10164
-mkv_episode_matcher/libraries/pgs2srt/Libraries/SubZero/post_processing.py,sha256=Zdcs6ESTOy49h19Brol__EhBvx2fBWj-6iKhuKoTwGM,9957
-mkv_episode_matcher/libraries/pgs2srt/Libraries/SubZero/dictionaries/data.py,sha256=n71bu8s0BXldXTFl1s0EpNHaGJfeanNagKYOLDASViQ,676829
-mkv_episode_matcher-0.1.4.dist-info/METADATA,sha256=izvBJO-INhIOdzOSfVfn3c1kUfkAjFyib-f-n0NGUyo,4351
-mkv_episode_matcher-0.1.4.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-mkv_episode_matcher-0.1.4.dist-info/entry_points.txt,sha256=IglJ43SuCZq2eQ3shMFILCkmQASJHnDCI3ogohW2Hn4,64
-mkv_episode_matcher-0.1.4.dist-info/RECORD,,