Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use knowit to parse video metadata (frame_rate, duration, subtitles...) #1154

Merged
merged 2 commits into from
Nov 23, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
add doc about knowit installation
getzze committed Nov 23, 2024
commit 43b9584993643b032ce948c0f9af005ff6669934
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -91,6 +91,8 @@ clone your fork locally and install a development version::
$ cd subliminal
$ pip install --user -e '.[dev,test,docs]'

To extract information about the video files, `subliminal` uses `knowit <https://github.com/ratoaq2/knowit`.
For better results, make sure one of its provider is installed, for instance `MediaInfo <https://mediaarea.net/en/MediaInfo>`.

Integrations
------------
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -15,6 +15,7 @@ Documentation
:maxdepth: 2

user/usage
user/installation
user/how_it_works
user/cli
user/provider_guide
30 changes: 30 additions & 0 deletions docs/user/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Installation
============

From Pypi
---------

For a better isolation with your system you should use a dedicated virtualenv.
The preferred installation method is to use `pipx <https://github.com/pypa/pipx>`_ that does that for you::

$ pipx install subliminal

Subliminal can be also be installed as a regular python module by running::

$ pip install --user subliminal

From source
-----------

If you want to modify the code, `fork <https://github.com/Diaoul/subliminal/fork>`_ this repo,
clone your fork locally and install a development version::

$ git clone https://github.com/<my-username>/subliminal
$ cd subliminal
$ pip install --user -e '.[dev,test,docs]'

External dependencies
---------------------

To extract information about the video files, `subliminal` uses `knowit <https://github.com/ratoaq2/knowit`.
For better results, make sure one of its provider is installed, for instance `MediaInfo <https://mediaarea.net/en/MediaInfo>`.