docs/installation.rst
.. highlight:: console
============
Installation
============
Stable release
--------------
To install pip-rating, run this command in your terminal:
.. code-block:: console
$ pip install pip-rating
This is the preferred method to install pip-rating, as it will always install the most recent stable release.
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
Other releases
--------------
You can install other versions from Pypi using::
$ pip install pip-rating==<version>
For versions that are not in Pypi (it is a development version)::
$ pip install git+https://github.com/Nekmo/pip-rating@<branch>#egg=pip-rating
From sources
------------
The sources for pip-rating can be downloaded from the `Github repo`_.
You can either clone the public repository:
.. code-block:: console
$ git clone git://github.com/Nekmo/pip-rating
Or download the `tarball`_:
.. code-block:: console
$ curl -OL https://github.com/Nekmo/pip-rating/tarball/master
Once you have a copy of the source, you can install it using the source directory:
.. code-block:: console
$ pip install /path/to/pip-rating
.. _Github repo: https://github.com/Nekmo/pip-rating
.. _tarball: https://github.com/Nekmo/pip-rating/tarball/master