Go to file
bastimeyer 9a0c64a78a chore: update Gitter link in issue template config 2023-02-14 12:31:58 +01:00
.github chore: update Gitter link in issue template config 2023-02-14 12:31:58 +01:00
docs docs: rewrite, fix and improve CLI tutorial 2023-02-12 12:15:02 -08:00
script chore: add "C4" rules to ruff config 2023-02-09 11:48:40 -08:00
src chore: fix issues introduced by ruff 0.0.245 2023-02-11 12:45:05 +01:00
tests chore: add "ISC" rules to ruff config 2023-02-09 11:48:40 -08:00
.codecov.yml ci.github: add regular Python 3.11 runners 2022-10-28 22:09:25 -07:00
.editorconfig ci: add netlify docs preview deploy config 2020-12-28 11:11:45 -08:00
.git-blame-ignore-revs tools: add .git-blame-ignore-revs 2023-02-10 12:30:31 -08:00
.gitattributes tools: remove export-subst from .gitattributes 2023-02-11 12:50:48 +01:00
.gitignore tools: add mypy config 2022-05-24 14:07:47 -07:00
AUTHORS AUTHORS: removed unused script and removed outdated list (#2889) 2020-04-12 21:13:15 +02:00
CHANGELOG.md release: 5.2.1 2023-01-23 23:37:32 +01:00
CODE_OF_CONDUCT.md docs: add minimalist code of conduct 2020-12-26 17:10:04 +01:00
CONTRIBUTING.md chore: replace issue templates with forms 2021-07-10 15:36:36 -07:00
KNOWN_ISSUES.md Improve contribution guidelines (#772) 2017-04-14 18:46:55 -07:00
LICENSE 2023 2023-01-01 01:23:38 +01:00
MANIFEST.in build: include icon.svg in sdist 2023-01-25 14:39:34 -08:00
README.md docs: remove Open Collective 2023-02-11 12:10:36 -08:00
dev-requirements.txt tools: replace flake8 with ruff 2023-02-09 09:54:14 -08:00
docs-requirements.txt docs: rewrite, fix and improve CLI tutorial 2023-02-12 12:15:02 -08:00
icon.svg Add icon, modify installer, update docs (#2165) 2018-12-31 04:37:51 +01:00
netlify.toml ci: fix git fetch in netlify build config 2022-07-11 10:56:44 -07:00
pyproject.toml chore: add "ISC" rules to ruff config 2023-02-09 11:48:40 -08:00
setup.cfg docs: remove Open Collective 2023-02-11 12:10:36 -08:00
setup.py chore: add "COM" rules to ruff config 2023-02-09 10:26:50 -08:00
signing.key.gpg build: include correct signing key: 0xE3DB9E282E390FA0 2020-04-24 12:01:28 +02:00

README.md

Streamlink
Streamlink

Supported Python versions Latest release License Open issues Build status Overall code coverage

A Python library and command-line interface which pipes streams from various services into a video player.
Avoid resource-heavy and unoptimized websites, and still enjoy streamed content.

Streamlink was forked in 2016 from the abandoned Livestreamer project.

📦 Installation

Please take a look at the documentation for different ways of installing Streamlink:

👍 Features

Streamlink is built on top of a plugin system which allows support for new services to be added easily.

Most of the popular streaming services are supported, such as:

... and many more. A list of all plugins currently included can be found on the plugins page.

💡 Quickstart

After installing, simply run:

streamlink "STREAMURL" best

The default behavior of Streamlink is to play back streams in the VLC player, but a lot of other options and output methods are available, such as writing the stream to the filesystem, reading stream metadata, etc.

For more in-depth usage, please refer to the CLI documentation.

An API guide and API reference is available for Python implementors of Streamlink.

🙏 Contributing

All contributions are welcome. Feel free to open a new thread on the issue tracker or submit a new pull request. Please read CONTRIBUTING.md first. Thanks!

❤️ Support

If you think that Streamlink is useful and if you want to keep the project alive, then please consider supporting its maintainers by sending a small and optionally recurring tip via the available options.
Your support is very much appreciated, thank you!