Go to file
beardypig b8b6c24940 include CHANGELOG.rst instead of .md in the egg 2017-01-12 07:38:46 +00:00
debian Debian packaging base (#80) 2016-10-27 19:30:58 -07:00
docs Merge pull request #328 from bastimeyer/automated-github-releases 2017-01-11 23:25:49 -08:00
examples Rename instances of "livestreamer" to "streamlink" 2016-09-19 15:46:06 -04:00
script Merge pull request #328 from bastimeyer/automated-github-releases 2017-01-11 23:25:49 -08:00
src --can-handle-url-no-redirect parameter added (#333) 2017-01-10 19:16:05 +00:00
tests --can-handle-url-no-redirect parameter added (#333) 2017-01-10 19:16:05 +00:00
win32 Optionally use FFMPEG to mux separate video and audio streams (#224) 2017-01-10 09:44:32 -08:00
.coveragerc Boost the test coverage a bit (#362) 2017-01-05 09:27:15 -08:00
.gitignore Boost the test coverage a bit (#362) 2017-01-05 09:27:15 -08:00
.travis.yml Set changelog in automated github releases 2017-01-11 18:41:25 +01:00
AUTHORS Add script to generate authors list / update authors 2016-09-23 16:34:47 -04:00
CHANGELOG.rst use iso 8601 date format for the changelog 2017-01-07 21:17:49 +00:00
CONTRIBUTING.md add contributing guidelines 2016-11-26 14:27:02 -05:00
LICENSE It's now 2016 2016-09-29 09:50:39 -04:00
MANIFEST.in include CHANGELOG.rst instead of .md in the egg 2017-01-12 07:38:46 +00:00
NOTICE packaging: removed the built in backports infavour of including them as dependencies when required (#355) 2017-01-05 01:25:30 -08:00
README.md Add links for windows portable version. (#299) 2016-12-15 09:25:28 -08:00
appveyor.yml ci: build and test on Python 3.6 (+3.7 on travis, with allowed failure) (#360) 2017-01-05 09:28:37 -08:00
build.cmd Windows command line parsing fix (#300) 2016-12-15 11:47:22 -08:00
codecov.yml tests: add codecov config file (#363) 2017-01-05 09:48:30 -08:00
deploy-key.enc Automated docs updates via travis-ci 2016-09-23 19:27:26 -04:00
dev-requirements.txt Windows command line parsing fix (#300) 2016-12-15 11:47:22 -08:00
requirements-docs.txt docs: Replace sphinxcontrib.issuetracker with my own extension. 2014-07-20 15:23:51 +02:00
setup.cfg Add setup.cfg with wheel settings. 2014-05-17 14:38:46 +02:00
setup.py packaging: removed the built in backports infavour of including them as dependencies when required (#355) 2017-01-05 01:25:30 -08:00

README.md

Streamlink

Build Status codecov.io

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.

Installation

Streamlink can be installed by using Python or through the installers below.

Installation via Python pip:

sudo pip install streamlink

Note: For Windows, omit "sudo"

Manual installation via Python:

git clone https://github.com/streamlink/streamlink
sudo python setup.py install

Installers for Windows/Mac/Linux:

Features

Streamlink is built via a plugin system which allows new services to be easily added.

Major streaming services such as:

Are supported.

A full list of plugins can be found on the plugin page.

Quickstart

After installation simply use:

streamlink twitch.tv/lirik source

And Streamlink will automatically open a default video player and begin streaming!

For full details on how to use Streamlink visit our documentation at streamlink.github.io

Contributing

Feel free to open a bug or contribute to code!

No need to go through a large CONTRIBUTING.md doc. The only requirement being that we get at least one ACK from a maintainer. Fork / clone us and open a PR!