streamlink/docs/install.rst

.. _install:

Installing
==========

Source
------

The latest stable version is available to install using `pip <http://www.pip-installer.org/>`_:

.. code-block:: console

    # pip install livestreamer

But you can also get the development version using `Git <http://git-scm.com/>`_:

.. code-block:: console

    $ git clone git://github.com/chrippa/livestreamer.git
    $ cd livestreamer
    # python setup.py install

`The Hitchhiker’s Guide to Python <http://docs.python-guide.org/>`_ has guides
helping you install Python + pip on the most common operating systems.

Dependencies
^^^^^^^^^^^^

Livestreamer currently depends on these libraries/programs to function.

To run the setup script you need:

- `Python <http://python.org/>`_ (at least version 2.6) or `PyPy <http://pypy.org/>`_
- `python-setuptools <http://pypi.python.org/pypi/setuptools>`_


These will be installed automatically by the setup script if they are missing:

- `python-argparse <http://pypi.python.org/pypi/argparse>`_ (only needed on Python version <2.7 and <3.2)
- `python-requests <http://docs.python-requests.org/>`_ (at least version 1.0)

Optional dependencies
^^^^^^^^^^^^^^^^^^^^^

For RTMP based plugins:

- `RTMPDump <http://rtmpdump.mplayerhq.hu/>`_

For decrypting encrypted HLS streams:

- `PyCrypto <https://www.dlitz.net/software/pycrypto/>`_

For full UStream.tv support:

- `python-librtmp <https://github.com/chrippa/python-librtmp>`_

Distribution packages
---------------------

Livestreamer is also available in these package repositories:

- `Arch Linux <https://www.archlinux.org/packages/community/any/livestreamer/>`_
- `FreeBSD <http://www.freshports.org/multimedia/livestreamer>`_
- `Gentoo Linux <https://packages.gentoo.org/package/net-misc/livestreamer>`_
- `OpenBSD <http://openports.se/multimedia/livestreamer>`_

Windows
^^^^^^^
Livestreamer is primarily developed for Unix-like operating systems where using a CLI is common. There is however a installer available for brave Windows users who don't mind using the command prompt.

The installer can be `downloaded from Github <https://github.com/chrippa/livestreamer/releases>`_. It contains a precompiled version of Livestreamer that does not require you to install any of the dependencies.
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
+								.. _install:
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
+								Installing
 								==========
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
+								Source
 								------
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
 								The latest stable version is available to install using `pip <http://www.pip-installer.org/>`_:
 								.. code-block:: console
 								    # pip install livestreamer
 								But you can also get the development version using `Git <http://git-scm.com/>`_:
 								.. code-block:: console
 								    $ git clone git://github.com/chrippa/livestreamer.git
 								    $ cd livestreamer
 								    # python setup.py install
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
+								`The Hitchhiker’s Guide to Python <http://docs.python-guide.org/>`_ has guides
 								helping you install Python + pip on the most common operating systems.
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
 								Dependencies
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
+								^^^^^^^^^^^^
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
-												docs: Change Windows download link.

											
										
										
											2013-07-06 19:52:21 +02:00
+								Livestreamer currently depends on these libraries/programs to function.
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
 								To run the setup script you need:
 								- `Python <http://python.org/>`_ (at least version 2.6) or `PyPy <http://pypy.org/>`_
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
+								- `python-setuptools <http://pypi.python.org/pypi/setuptools>`_
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
 								These will be installed automatically by the setup script if they are missing:
 								- `python-argparse <http://pypi.python.org/pypi/argparse>`_ (only needed on Python version <2.7 and <3.2)
 								- `python-requests <http://docs.python-requests.org/>`_ (at least version 1.0)
 								Optional dependencies
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
+								^^^^^^^^^^^^^^^^^^^^^
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
 								For RTMP based plugins:
-												docs: Remove Twitch/Justin.tv specific rtmpdump issues.

											
										
										
											2013-12-14 20:04:46 +01:00
+								- `RTMPDump <http://rtmpdump.mplayerhq.hu/>`_
-												Major restructuring of the docs.

											
										
										
											2013-03-14 03:02:31 +01:00
 								For decrypting encrypted HLS streams:
 								- `PyCrypto <https://www.dlitz.net/software/pycrypto/>`_
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
+								For full UStream.tv support:
 								- `python-librtmp <https://github.com/chrippa/python-librtmp>`_
-												docs: Now available in the official Gentoo portage tree.

											
										
										
											2013-11-03 01:11:20 +01:00
+								Distribution packages
 								---------------------
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
-												docs: Now available in the official Gentoo portage tree.

											
										
										
											2013-11-03 01:11:20 +01:00
+								Livestreamer is also available in these package repositories:
 								- `Arch Linux <https://www.archlinux.org/packages/community/any/livestreamer/>`_
-												docs: Now also available in FreeBSD ports!

											
										
										
											2013-12-02 00:52:13 +01:00
+								- `FreeBSD <http://www.freshports.org/multimedia/livestreamer>`_
-												docs: Now available in the official Gentoo portage tree.

											
										
										
											2013-11-03 01:11:20 +01:00
+								- `Gentoo Linux <https://packages.gentoo.org/package/net-misc/livestreamer>`_
 								- `OpenBSD <http://openports.se/multimedia/livestreamer>`_
-												Update docs.

											
										
										
											2013-09-29 22:01:31 +02:00
 								Windows
 								^^^^^^^
 								Livestreamer is primarily developed for Unix-like operating systems where using a CLI is common. There is however a installer available for brave Windows users who don't mind using the command prompt.
 								The installer can be `downloaded from Github <https://github.com/chrippa/livestreamer/releases>`_. It contains a precompiled version of Livestreamer that does not require you to install any of the dependencies.