deffd929d1
* rename CHANGELOG to md * symlink the change log in to the docs * include the recommonmark parser for md file * reformatted the CHANGELOG md file, should look more or less the same as the RST * refactored the release scripts to handle/generate the new format * file is a bad variable name * couple of minor tweaks, mainly style * Fix git shortlog being highlighted as Python in the docs * update manifest to include changelog.md instead of rst |
||
---|---|---|
docs | ||
examples | ||
script | ||
src | ||
tests | ||
win32 | ||
.coveragerc | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
AUTHORS | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
ISSUE_TEMPLATE.md | ||
KNOWN_ISSUES.md | ||
LICENSE | ||
MANIFEST.in | ||
NOTICE | ||
README.md | ||
appveyor.yml | ||
build.cmd | ||
codecov.yml | ||
deploy-key.enc | ||
dev-requirements.txt | ||
docs-requirements.txt | ||
setup.cfg | ||
setup.py | ||
versioneer.py |
README.md
Streamlink
Streamlink is a CLI utility that pipes flash videos from online streaming services to a variety of video players such as VLC, or alternatively, a browser.
The main purpose of streamlink is to convert CPU-heavy flash plugins to a less CPU-intensive format.
Streamlink is a fork of the Livestreamer project.
Please note that by using this application you're bypassing ads run by sites such as Twitch.tv. Please consider donating or paying for subscription services when they are available for the content you consume and enjoy.
Installation
Installation via Python pip
sudo pip install streamlink
Manual installation via Python
git clone https://github.com/streamlink/streamlink
cd streamlink
sudo python setup.py install
Windows, MacOS, Linux and BSD specific installation methods
Features
Streamlink is built via a plugin system which allows new services to be easily added.
Supported streaming services, among many others, are:
A list of all supported plugins can be found on the plugin page.
Quickstart
After installing, simply use:
streamlink STREAMURL best
Streamlink will automatically open the stream in its default video player! See Streamlink's detailed documentation for all available configuration options, CLI parameters and usage examples.
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!
Backers
Thank you to all our backers! [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]