subliminal 2.2.0__tar.gz → 2.2.1__tar.gz

{subliminal-2.2.0 → subliminal-2.2.1}/HISTORY.rst

@@ -1,6 +1,14 @@
 Changelog
 ---------
 
+2.2.1
+^^^^^
+**release date:** 2024-06-27
+
+* Add example subliminal.toml to documentation and fix documentation.
+* [CLI] show the message about the config file only with the ``--debug`` option.
+* Relax the ``platformdirs`` dependency requirement to ``>= 3``
+
 2.2.0
 ^^^^^
 **release date:** 2024-06-24

{subliminal-2.2.0 → subliminal-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: subliminal
-Version: 2.2.0
+Version: 2.2.1
 Summary: Subtitles, faster than your thoughts
 Author-email: Antoine Bertin <diaoulael@gmail.com>
 Maintainer-email: Antoine Bertin <diaoulael@gmail.com>, getzze <getzze@gmail.com>, Patrycja Rosa <pypi@ptrcnull.me>
@@ -33,7 +33,7 @@ Requires-Dist: click-option-group>=0.5.6
 Requires-Dist: dogpile.cache>=1.0
 Requires-Dist: enzyme>=0.5.0
 Requires-Dist: guessit>=3.0.0
-Requires-Dist: platformdirs>=4.2
+Requires-Dist: platformdirs>=3
 Requires-Dist: pysubs2>=1.7
 Requires-Dist: rarfile>=2.7
 Requires-Dist: requests>=2.0
@@ -154,6 +154,14 @@ See the dedicated `project page <https://github.com/Diaoul/nautilus-subliminal>`
 Changelog
 ---------
 
+2.2.1
+^^^^^
+**release date:** 2024-06-27
+
+* Add example subliminal.toml to documentation and fix documentation.
+* [CLI] show the message about the config file only with the ``--debug`` option.
+* Relax the ``platformdirs`` dependency requirement to ``>= 3``
+
 2.2.0
 ^^^^^
 **release date:** 2024-06-24

subliminal-2.2.1/docs/api/cli.rst

@@ -0,0 +1,5 @@
+CLI
+===
+.. automodule:: subliminal.cli
+    :members:
+    :exclude-members: MutexLock, plural

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/core.rst

@@ -1,6 +1,7 @@
 Core
 ====
 .. automodule:: subliminal.core
+    :members:
     :exclude-members: ARCHIVE_EXTENSIONS
 
     .. autodata:: ARCHIVE_EXTENSIONS

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/exceptions.rst

@@ -1,3 +1,4 @@
 Exceptions
 ==========
 .. automodule:: subliminal.exceptions
+    :members:

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/extensions.rst

@@ -1,3 +1,4 @@
 Extensions
 ==========
 .. automodule:: subliminal.extensions
+    :members:

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/providers.rst

@@ -1,38 +1,46 @@
 Providers
 =========
 .. automodule:: subliminal.providers
+   :members:
 
 Addic7ed
 --------
 .. automodule:: subliminal.providers.addic7ed
+   :members:
    :private-members:
 
 Gestdown
 --------
 .. automodule:: subliminal.providers.gestdown
+   :members:
    :private-members:
 
 NapiProjekt
 -----------
 .. automodule:: subliminal.providers.napiprojekt
+   :members:
    :private-members:
 
 OpenSubtitles
 -------------
 .. automodule:: subliminal.providers.opensubtitles
+   :members:
    :private-members:
 
 OpenSubtitles.com
 -----------------
 .. automodule:: subliminal.providers.opensubtitlescom
+   :members:
    :private-members:
 
 Podnapisi
 ---------
 .. automodule:: subliminal.providers.podnapisi
+   :members:
    :private-members:
 
 TVsubtitles
 -----------
 .. automodule:: subliminal.providers.tvsubtitles
+   :members:
    :private-members:

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/refiners.rst

@@ -5,6 +5,11 @@ Refiners
 .. automodule:: subliminal.refiners
 
 
+Hash
+--------
+.. autofunction:: subliminal.refiners.hash.refine
+
+
 Metadata
 --------
 .. autofunction:: subliminal.refiners.metadata.refine

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/score.rst

@@ -1,3 +1,4 @@
 Score
 =====
 .. automodule:: subliminal.score
+    :members:

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/subtitle.rst

@@ -1,6 +1,7 @@
 Subtitle
 ========
 .. automodule:: subliminal.subtitle
+    :members:
     :exclude-members: SUBTITLE_EXTENSIONS
 
     .. autodata:: SUBTITLE_EXTENSIONS

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/utils.rst

@@ -1,3 +1,4 @@
 Utils
 =====
 .. automodule:: subliminal.utils
+    :members:

{subliminal-2.2.0 → subliminal-2.2.1}/docs/api/video.rst

@@ -1,6 +1,7 @@
 Video
 =====
 .. automodule:: subliminal.video
+    :members:
     :exclude-members: VIDEO_EXTENSIONS
 
     .. autodata:: VIDEO_EXTENSIONS

{subliminal-2.2.0 → subliminal-2.2.1}/docs/conf.py

@@ -73,7 +73,7 @@ release = subliminal.__version__
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -304,7 +304,6 @@ intersphinx_mapping = {
     'guessit': ('https://guessit.readthedocs.org/en/latest', None),
     'babelfish': ('https://babelfish.readthedocs.org/en/latest', None),
     'dogpilecache': ('https://dogpilecache.sqlalchemy.org/en/latest', None),
-    'dogpilecore': ('https://dogpilecore.readthedocs.org/en/latest', None),
     'stevedore': ('https://docs.openstack.org/stevedore/latest', None),
     'click': ('https://click.palletsprojects.com/en/latest/', None),
 }

{subliminal-2.2.0 → subliminal-2.2.1}/docs/config.toml

@@ -2,13 +2,14 @@
 cache_dir = "~/.cache/subliminal"
 
 [provider.opensubtitlescom]
-username = "python-subliminal-test"
+username = "subliminal"
 password = "subliminal"
 apikey = "mij33pjc3kOlup1qOKxnWWxvle2kFbMH"
 
 [provider.addic7ed]
 username = "subliminal"
 password = "subliminal"
+timeout = 20
 
 [refiner.omdb]
 apikey = "44d5b275"
@@ -18,7 +19,7 @@ apikey = "xxxxxxxxx"
 
 [download]
 provider = ["addic7ed", "opensubtitlescom", "opensubtitles"]
-refiner = ["metadata", "hash", "omdb", "tvdb"]
+refiner = ["metadata", "hash", "omdb", "tmdb"]
 language = ["fr", "en", "pt-br"]
 encoding = "utf-8"
 min_score = 50

{subliminal-2.2.0 → subliminal-2.2.1}/docs/index.rst

@@ -5,7 +5,7 @@
 
 Welcome to subliminal!
 ======================
-Subliminal is a python 2.7+ library to search and download subtitles.
+Subliminal is a python3 library to search and download subtitles.
 It comes with an easy to use yet powerful :abbr:`CLI (command-line interface)` suitable for direct use or cron jobs.
 
 

{subliminal-2.2.0 → subliminal-2.2.1}/docs/user/usage.rst

@@ -24,6 +24,11 @@ provided, it looks for a ``subliminal.toml`` file in the default configuration f
 - MacOS: ``/Users/<user>/Library/Application Support/subliminal/subliminal.toml``
 - Windows: ``C:\\Users\\<user>\\AppData\\Local\\Acme\\subliminal\\subliminal.toml``
 
+Example of a ``subliminal.toml`` file:
+
+.. literalinclude:: ../config.toml
+    :language: toml
+
 See :ref:`cli` for more details on the available commands and options.
 
 

{subliminal-2.2.0 → subliminal-2.2.1}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "dogpile.cache>=1.0",
     "enzyme>=0.5.0",
     "guessit>=3.0.0",
-    "platformdirs>=4.2",
+    "platformdirs>=3",
     "pysubs2>=1.7",
     "rarfile>=2.7",
     "requests>=2.0",

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal/__init__.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 __title__: str = 'subliminal'
-__version__: str = '2.2.0'
+__version__: str = '2.2.1'
 __short_version__: str = '.'.join(__version__.split('.')[:2])
 __author__: str = 'Antoine Bertin'
 __license__: str = 'MIT'

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal/cli.py

@@ -118,6 +118,7 @@ class AgeParamType(click.ParamType):
 def configure(ctx: click.Context, param: click.Parameter | None, filename: str | os.PathLike) -> None:
     """Read a configuration file."""
     filename = pathlib.Path(filename).expanduser()
+    msg = ''
     toml_dict = {}
     if filename.is_file():
         try:
@@ -125,13 +126,10 @@ def configure(ctx: click.Context, param: click.Parameter | None, filename: str |
                 toml_dict = tomli.load(f)
         except tomli.TOMLDecodeError:
             msg = f'Cannot read the configuration file at {filename}'
-            click.echo(msg)
         else:
             msg = f'Using configuration file at {filename}'
-            click.echo(msg)
     else:
         msg = 'Not using any configuration file.'
-        click.echo(msg)
 
     options = {}
 
@@ -148,7 +146,11 @@ def configure(ctx: click.Context, param: click.Parameter | None, filename: str |
     providers_dict = toml_dict.setdefault('provider', {})
     refiners_dict = toml_dict.setdefault('refiner', {})
 
-    ctx.obj = {'provider_configs': providers_dict, 'refiner_configs': refiners_dict}
+    ctx.obj = {
+        '__config__': {'dict': toml_dict, 'debug_message': msg},
+        'provider_configs': providers_dict,
+        'refiner_configs': refiners_dict,
+    }
     ctx.default_map = options
 
 
@@ -254,6 +256,9 @@ def subliminal(
         handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT))
         logging.getLogger('subliminal').addHandler(handler)
         logging.getLogger('subliminal').setLevel(logging.DEBUG)
+        # log about the config file
+        msg = ctx.obj['__config__']['debug_message']
+        logger.info(msg)
 
     ctx.obj['debug'] = debug
     # provider configs

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal/extensions.py

@@ -13,7 +13,7 @@ if TYPE_CHECKING:
 
 
 class RegistrableExtensionManager(ExtensionManager):
-    """:class:~stevedore.extensions.ExtensionManager` with support for registration.
+    """:class:`stevedore.extensions.ExtensionManager` with support for registration.
 
     It allows loading of internal extensions without setup and registering/unregistering additional extensions.
 
@@ -23,9 +23,9 @@ class RegistrableExtensionManager(ExtensionManager):
     * Internal extensions
     * Registered extensions
 
-    :param str namespace: namespace argument for :class:~stevedore.extensions.ExtensionManager`.
+    :param str namespace: namespace argument for :class:`stevedore.extensions.ExtensionManager`.
     :param list internal_extensions: internal extensions to use with entry point syntax.
-    :param kwargs: additional parameters for the :class:~stevedore.extensions.ExtensionManager` constructor.
+    :param kwargs: additional parameters for the :class:`stevedore.extensions.ExtensionManager` constructor.
 
     """
 

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal/providers/__init__.py

@@ -1,24 +1,11 @@
 """
 Providers list and download subtitles for a :class:`~subliminal.video.Video` object.
 
-A Provider is a ContextManager with `__enter__` and `__exit__` methods and two public methods:
-
-.. py:method:: list_subtitles(self, video, languages)
-
-    :param video: video to list subtitles for.
-    :type video: :class:`~subliminal.video.Video`
-    :param languages: languages to search for.
-    :type languages: set of :class:`~babelfish.language.Language`
-    :return: found subtitles.
-    :rtype: list of :class:`~subliminal.subtitle.Subtitle`
-    :raise: :class:`~subliminal.exceptions.ProviderError`
-
-
-.. py:method:: download_subtitle(self, subtitle)
-
-    :param subtitle: subtitle to download.
-    :type subtitle: :class:`~subliminal.subtitle.Subtitle`
-    :raise: :class:`~subliminal.exceptions.ProviderError`
+A Provider is a ContextManager with :meth:`~subliminal.Provider.__enter__` and
+:meth:`~subliminal.Provider.__exit__`
+methods and two public methods,
+:py:meth:`~subliminal.Provider.list_subtitles(video, languages)` and
+:py:meth:`~subliminal.Provider.download_subtitle(subtitle)`.
 
 """
 
@@ -51,7 +38,7 @@ logger = logging.getLogger(__name__)
 
 
 class SecLevelOneTLSAdapter(adapters.HTTPAdapter):
-    """``HTTPAdapter`` with security level set to 1."""
+    """:class:`~requests.adapters.HTTPAdapter` with security level set to 1."""
 
     def init_poolmanager(self, connections: int, maxsize: int, block: bool = False, **pool_kwargs: Any) -> None:  # noqa: FBT001, FBT002
         """Create and initialize the urllib3 PoolManager."""
@@ -67,7 +54,7 @@ class SecLevelOneTLSAdapter(adapters.HTTPAdapter):
 
 
 class TimeoutSafeTransport(SafeTransport):
-    """Timeout support for ``xmlrpc.client.SafeTransport``."""
+    """Timeout support for :class:`~xmlrpc.client.SafeTransport`."""
 
     timeout: float | None
 
@@ -76,7 +63,14 @@ class TimeoutSafeTransport(SafeTransport):
         self.timeout = timeout
 
     def make_connection(self, host: _HostType) -> HTTPSConnection:
-        """Make connection to host."""
+        """Make connection to host.
+
+        :param host: the connection host.
+        :type host: :class:`~xmlrpc.client._HostType`
+        :return: the HTTPS connection.
+        :rtype: :class:`~http.client import HTTPSConnection`
+
+        """
         c = SafeTransport.make_connection(self, host)
         c.timeout = self.timeout
 
@@ -84,10 +78,10 @@ class TimeoutSafeTransport(SafeTransport):
 
 
 class ParserBeautifulSoup(BeautifulSoup):
-    """A ``bs4.BeautifulSoup`` that picks the first parser available in `parsers`.
+    """A :class:`~bs4.BeautifulSoup` that picks the first parser available in `parsers`.
 
-    :param markup: markup for the ``bs4.BeautifulSoup``.
-    :param list parsers: parser names, in order of preference.
+    :param (str | bytes) markup: markup for the :class:`~bs4.BeautifulSoup`.
+    :param list[str] parsers: parser names, in order of preference.
 
     """
 
@@ -127,7 +121,7 @@ class Provider(Generic[S]):
 
     If any configuration is possible for the provider, like credentials, it must take place during instantiation.
 
-    :raise: :class:`~subliminal.exceptions.ConfigurationError` if there is a configuration error
+    :raises: :class:`~subliminal.exceptions.ConfigurationError` if there is a configuration error
 
     """
 

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal/providers/gestdown.py

@@ -237,10 +237,10 @@ class GestdownProvider(Provider):
 
         :param str show_id: the show id.
         :param int season: the season to query.
-        :param :class:`~babelfish.language.Language` language: the language of the subtitles.
+        :param language: the language of the subtitles.
+        :type language: :class:`~babelfish.language.Language`
         :return: the list of found subtitles (as dicts).
         :rtype: list[dict[str, Any]]
-
         """
         if self.session is None:
             raise NotInitializedProviderError
@@ -274,10 +274,10 @@ class GestdownProvider(Provider):
         :param str show_id: the show id.
         :param int season: the season to query.
         :param int episode: the episode to query.
-        :param :class:`~babelfish.language.Language` language: the language of the subtitles.
+        :param language: the language of the subtitles.
+        :type language: :class:`~babelfish.language.Language`
         :return: the list of found subtitles (as dicts).
         :rtype: list[dict[str, Any]]
-
         """
         if self.session is None:
             raise NotInitializedProviderError
@@ -318,7 +318,8 @@ class GestdownProvider(Provider):
         :param str series: the series title.
         :param int season: the season number.
         :param int episode: the episode number.
-        :param :class:`~babelfish.language.Language` language: the language of the subtitles.
+        :param language: the language of the subtitles.
+        :type language: :class:`~babelfish.language.Language`
         :return: the list of found subtitles.
         :rtype: list[GestdownSubtitle]
 

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal/utils.py

@@ -174,7 +174,7 @@ def is_iterable(obj: Any) -> TypeGuard[Iterable]:
 def ensure_list(value: T | Sequence[T] | None) -> list[T]:
     """Ensure to return a list of values.
 
-    From rebulk.loose.ensure_list
+    From :func:`rebulk.loose.ensure_list`.
     """
     if value is None:
         return []

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal/video.py

@@ -117,7 +117,8 @@ class Video:
     :param str audio_codec: codec of the main audio stream.
     :param dict hashes: hashes of the video file by provider names.
     :param int size: size of the video file in bytes.
-    :param set subtitle_languages: existing subtitle languages.
+    :param subtitle_languages: existing subtitle languages.
+    :type subtitle_languages: set[:class:`~babelfish.language.Language`]
     :param int year: year of the video.
     :param country: Country of the video.
     :type country: :class:`~babelfish.country.Country`
@@ -399,7 +400,7 @@ class Movie(Video):
     :param int year: year of the movie.
     :param country: Country of the movie.
     :type country: :class:`~babelfish.country.Country`
-    :param list alternative_titles: alternative titles of the movie
+    :param list[str] alternative_titles: alternative titles of the movie
     :param kwargs: additional parameters for the :class:`Video` constructor.
 
     """

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: subliminal
-Version: 2.2.0
+Version: 2.2.1
 Summary: Subtitles, faster than your thoughts
 Author-email: Antoine Bertin <diaoulael@gmail.com>
 Maintainer-email: Antoine Bertin <diaoulael@gmail.com>, getzze <getzze@gmail.com>, Patrycja Rosa <pypi@ptrcnull.me>
@@ -33,7 +33,7 @@ Requires-Dist: click-option-group>=0.5.6
 Requires-Dist: dogpile.cache>=1.0
 Requires-Dist: enzyme>=0.5.0
 Requires-Dist: guessit>=3.0.0
-Requires-Dist: platformdirs>=4.2
+Requires-Dist: platformdirs>=3
 Requires-Dist: pysubs2>=1.7
 Requires-Dist: rarfile>=2.7
 Requires-Dist: requests>=2.0
@@ -154,6 +154,14 @@ See the dedicated `project page <https://github.com/Diaoul/nautilus-subliminal>`
 Changelog
 ---------
 
+2.2.1
+^^^^^
+**release date:** 2024-06-27
+
+* Add example subliminal.toml to documentation and fix documentation.
+* [CLI] show the message about the config file only with the ``--debug`` option.
+* Relax the ``platformdirs`` dependency requirement to ``>= 3``
+
 2.2.0
 ^^^^^
 **release date:** 2024-06-24

{subliminal-2.2.0 → subliminal-2.2.1}/subliminal.egg-info/requires.txt

@@ -6,7 +6,7 @@ click-option-group>=0.5.6
 dogpile.cache>=1.0
 enzyme>=0.5.0
 guessit>=3.0.0
-platformdirs>=4.2
+platformdirs>=3
 pysubs2>=1.7
 rarfile>=2.7
 requests>=2.0

subliminal-2.2.0/docs/api/cli.rst

@@ -1,3 +0,0 @@
-CLI
-===
-.. automodule:: subliminal.cli