Go to file
Charlie Drage 4c50a351f1 Fix underlining issue
Closes https://github.com/streamlink/streamlink/issues/527
2017-02-03 13:55:05 -05:00
debian Update license and debian copyright (#515) 2017-02-01 07:13:47 +00:00
docs Add support for Huya.com in issue #425 (#465) 2017-02-02 15:25:59 -08:00
examples Add blank line after class or function definition (#408) 2017-01-12 14:54:55 +00:00
script Fix underlining issue 2017-02-03 13:55:05 -05:00
src Add support for Huya.com in issue #425 (#465) 2017-02-02 15:25:59 -08:00
tests plugins.bongacams: a few small changes (#429) 2017-02-01 13:35:16 -08: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 docs: tweaks to docs and docs build process 2017-01-16 11:52:14 +00:00
AUTHORS Add script to generate authors list / update authors 2016-09-23 16:34:47 -04:00
CHANGELOG.rst 0.3.0 Release 2017-01-24 14:06:45 -05:00
CONTRIBUTING.md add contributing guidelines 2016-11-26 14:27:02 -05:00
ISSUE_TEMPLATE.md Add a github issue template 2017-01-22 00:43:07 +01: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 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
docs-requirements.txt docs: tweaks to docs and docs build process 2017-01-16 11:52:14 +00:00
setup.cfg Add setup.cfg with wheel settings. 2014-05-17 14:38:46 +02:00
setup.py add a general locale setting which can be used by plugins 2017-01-25 14:12:38 +00: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!