Go to file

beardypig 7b43ca4f36 docs: update Sphinx config to fix the rendering of --		2017-05-22 09:37:48 +01:00
debian	Update license and debian copyright (#515 )	2017-02-01 07:13:47 +00:00
docs	docs: update Sphinx config to fix the rendering of --	2017-05-22 09:37:48 +01:00
examples	Add blank line after class or function definition (#408 )	2017-01-12 14:54:55 +00:00
script	build: update the bintray release notes for nightlies	2017-05-09 10:22:04 +01:00
src	Merge pull request #927 from beardypig/iplayer-login	2017-05-16 09:12:46 -07:00
tests	Add unit tests for Euronews plugin	2017-05-10 21:15:02 +02:00
win32	Fix bug in customized Windows install	2017-01-25 09:47:18 +00: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	build: update the bintray release notes for nightlies	2017-05-09 10:22:04 +01:00
AUTHORS	Add script to generate authors list / update authors	2016-09-23 16:34:47 -04:00
CHANGELOG.rst	0.6.0 Release	2017-05-11 09:54:11 -04:00
CONTRIBUTING.md	Improve contribution guidelines (#772 )	2017-04-14 18:46:55 -07:00
ISSUE_TEMPLATE.md	Improve contribution guidelines (#772 )	2017-04-14 18:46:55 -07:00
KNOWN_ISSUES.md	Improve contribution guidelines (#772 )	2017-04-14 18:46:55 -07:00
LICENSE	Update license and debian copyright (#515 )	2017-02-01 07:13:47 +00:00
MANIFEST.in	docs: tweaks to docs and docs build process	2017-01-16 11:52:14 +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	Make notice more agnostic	2017-04-05 10:35:03 -07:00
appveyor.yml	appveyor: update config to fix builds on Python 3.3	2017-04-28 12:09:01 +01: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
docs-requirements.txt	docs: tweaks to docs and docs build process	2017-01-16 11:52:14 +00:00
livestream.patch	plugins.vaughnlive: search for player version, etc in the swf file	2017-03-10 17:52:23 +00:00
setup.cfg	Add setup.cfg with wheel settings.	2014-05-17 14:38:46 +02:00
setup.py	0.6.0 Release	2017-05-11 09:54:11 -04:00

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

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!