Skip to content

Commit f50fbd6

Browse files
authored
Update installation.rst (#231)
Clarified that some errors during byte-compiling is fine.
1 parent 358b9c3 commit f50fbd6

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

docs/installation.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Minimum Requirements
1919
document these where possible.
2020

2121

22-
*******************
23-
Installing manually
24-
*******************
22+
******************************
23+
Installing into ``PYTHONPATH``
24+
******************************
2525
You can `download the latest release from Github <https://github.com/shotgunsoftware/python-api/releases>`_
2626
or `clone the repo <https://github.com/shotgunsoftware/python-api>`_ to your local filesystem.
2727
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::
5050
pip install git+git://github.com/shotgunsoftware/python-api.git@v3.0.26
5151

5252

53-
requirements.txt
54-
~~~~~~~~~~~~~~~~
53+
``requirements.txt``
54+
~~~~~~~~~~~~~~~~~~~~
5555
If you're using pip with `requirements.txt`, add the following line::
5656

5757
git+git://github.com/shotgunsoftware/python-api.git
58+
59+
60+
****************************
61+
Installing with ``setup.py``
62+
****************************
63+
64+
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.

0 commit comments

Comments
 (0)