Skip to content
This repository has been archived by the owner on Nov 10, 2020. It is now read-only.

Commit

Permalink
Added installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lycantropos committed Sep 16, 2017
1 parent d8410ac commit 623dcfe
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
.. contents::


In what follows ``python3`` is an alias for ``python3.5``
or any later version (``python3.6`` and so on).

Installation
------------
Install the latest ``pip`` & ``setuptools`` packages versions

.. code-block:: bash
python3 -m pip install --upgrade pip setuptools
Release
~~~~~~~
Download and install the latest stable [#]_ version with ``pip``

.. code-block:: bash
python3 -m pip install --upgrade asynctmdb
Developer
~~~~~~~~~
.. code-block:: bash
git clone https://github.com/lycantropos/asynctmdb.git
cd asynctmdb
python3 setup.py install
Methods
-------

Expand Down Expand Up @@ -204,6 +233,7 @@ TV EPISODES
- `Delete Rating <https://developers.themoviedb.org/3/tv-episodes/delete-rating>`__
- `Get Videos <https://developers.themoviedb.org/3/tv-episodes/get-videos>`__


Running tests
-------------

Expand All @@ -226,10 +256,13 @@ Plain

.. code-block:: bash
./set-api-key.sh ./set-login.sh python3.5 setup.py test
./set-api-key.sh ./set-login.sh python3 setup.py test
Inside ``Docker`` container

.. code-block:: bash
./set-env.sh docker-compose up
.. [#] At least we hope so.

0 comments on commit 623dcfe

Please sign in to comment.