github
/
streamlink
mirror of https://github.com/streamlink/streamlink
1
Fork 0
Code Releases Activity

docs: add sdist section to install page

This commit is contained in:
bastimeyer 2023-10-23 19:22:42 +02:00 committed by Sebastian Meyer
parent 13762836c2
commit 149f3cd10c
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/install.rst
View File

@ -393,22 +393,38 @@ install it first, either with a system package manager, or using ``pip``, as det
.. _pipx: https://pypa.github.io/pipx/
Dependencies
------------
Source distribution
-------------------
To install Streamlink from source you will need these dependencies.
In addition to the pre-built wheels uploaded to PyPI, Streamlink's source distribution tarballs get uploaded
to both PyPI and GitHub releases. These tarballs are meant for packagers and are signed using the following PGP key:
Since :ref:`4.0.0 <changelog:streamlink 4.0.0 (2022-05-01)>`,
Streamlink defines a `build system <pyproject.toml_>`__ according to `PEP-517`_ / `PEP-518`_.
:bdg-link-primary-line:`44448A298D5C3618 <https://keyserver.ubuntu.com/pks/lookup?search=44448A298D5C3618&fingerprint=on&op=index>`
Please be aware that PyPI has dropped support for uploading new release file signatures in May 2023, so those can only be found
on `GitHub releases`_ now.
See the `Dependencies`_ section down below for the required build- and runtime-requirements.
.. warning::
Do not build Streamlink from tarballs generated by GitHub from (tagged) git commits,
as they are lacking the release version string.
Please avoid building Streamlink from tarballs generated by GitHub from (tagged) git commits,
as they are lacking the built-in release version string. The ``versioningit`` build-requirement also won't be able
to find the correct version, as the content is not part of a git repository.
Instead, install from Streamlink's signed source-distribution tarballs which are uploaded to PyPI and GitHub releases,
Instead, build from Streamlink's signed source-distribution tarballs which are uploaded to PyPI and GitHub releases,
or from the cloned git repository.
.. _GitHub Releases: https://github.com/streamlink/streamlink/releases
Dependencies
^^^^^^^^^^^^
To install Streamlink from source, you will need these dependencies.
Since :ref:`4.0.0 <changelog:streamlink 4.0.0 (2022-05-01)>`,
Streamlink defines a `build system <pyproject.toml_>`__ according to `PEP-517`_ / `PEP-518`_.
.. list-table::
:header-rows: 1
:class: table-custom-layout table-custom-layout-dependencies