From 59dfab877d2020fd12b4f54c577558356221623e Mon Sep 17 00:00:00 2001 From: getzze Date: Tue, 7 Jan 2025 22:42:17 +0000 Subject: [PATCH] Add main news (#1200) * improve docs * add news for calling python -m subliminal --- changelog.d/1197.change.rst | 1 + docs/user/installation.rst | 6 +++--- docs/user/usage.rst | 6 ++++++ src/subliminal/core.py | 2 +- 4 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 changelog.d/1197.change.rst diff --git a/changelog.d/1197.change.rst b/changelog.d/1197.change.rst new file mode 100644 index 00000000..e28909e7 --- /dev/null +++ b/changelog.d/1197.change.rst @@ -0,0 +1 @@ +Can use `python -m subliminal` diff --git a/docs/user/installation.rst b/docs/user/installation.rst index c1cf836e..330f4aaf 100644 --- a/docs/user/installation.rst +++ b/docs/user/installation.rst @@ -21,10 +21,10 @@ clone your fork locally and install a development version:: $ git clone https://github.com//subliminal $ cd subliminal - $ pip install --user -e '.[dev,test,docs]' + $ pip install --user -e '.[dev,tests,docs]' External dependencies --------------------- -To extract information about the video files, `subliminal` uses `knowit `. +To extract information about the video files, ``subliminal`` uses `knowit `_. +For better results, make sure one of its provider is installed, for instance `MediaInfo `_. diff --git a/docs/user/usage.rst b/docs/user/usage.rst index 1eb13c69..c82d3450 100644 --- a/docs/user/usage.rst +++ b/docs/user/usage.rst @@ -47,6 +47,12 @@ Example of a ``subliminal.toml`` file: See :ref:`cli` for more details on the available commands and options. +.. note:: + + The subliminal module can also be called from the command line:: + + $ python -m subliminal download -h + Nautilus/Nemo integration ------------------------- diff --git a/src/subliminal/core.py b/src/subliminal/core.py index c464b9cc..f9acc86e 100644 --- a/src/subliminal/core.py +++ b/src/subliminal/core.py @@ -37,7 +37,7 @@ from subliminal.score import ComputeScore -#: Supported archive extensions +#: Supported archive extensions (.rar) ARCHIVE_EXTENSIONS = ('.rar',) logger = logging.getLogger(__name__)