diff --git a/docs/installation.rst b/docs/installation.rst index 880021ec1..ddafc78c5 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -19,9 +19,9 @@ Minimum Requirements document these where possible. -******************* -Installing manually -******************* +****************************** +Installing into ``PYTHONPATH`` +****************************** You can `download the latest release from Github `_ or `clone the repo `_ to your local filesystem. You'll need to save it somewhere your local Python installation can find it. @@ -50,8 +50,15 @@ installs the v3.0.26 tag, replace the version tag with the one you want:: pip install git+git://github.com/shotgunsoftware/python-api.git@v3.0.26 -requirements.txt -~~~~~~~~~~~~~~~~ +``requirements.txt`` +~~~~~~~~~~~~~~~~~~~~ If you're using pip with `requirements.txt`, add the following line:: git+git://github.com/shotgunsoftware/python-api.git + + +**************************** +Installing with ``setup.py`` +**************************** + +From a local copy of the repository, you can run ``python setup.py install`` to copy the package inside your python ``site-packages``. Note that while ``setuptools`` will complain about syntax errors when installing the library, the library is fully functional. However, it ships with both Python 2 and Python 3 copies of ``httplib2``, which will generate syntax errors when byte-compiling the Python modules.