Skip to content

Commit 439979c

Browse files
author
KP
committed
Updated pip installation instructions
Recommend installing specific tagged versions over master.
1 parent 28043b2 commit 439979c

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.mdown

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,17 @@ Shotgun provides a simple Python-based API for accessing Shotgun and integrating
2020
To use Shotgun's Python API module, you need to place the package shotgun_api3 in one of the directories specified by the environment variable PYTHONPATH. For more information on PYTHONPATH and using modules in Python, see http://docs.python.org/tutorial/modules.html
2121

2222
### Installing with `pip`
23-
To install this package with `pip`, run the following command:
23+
24+
#### Specific Versions
25+
To install a specific version of the package with `pip` (recommended), run the following command
26+
(This example installs the v3.0.9 tag. Replace the version tag with the one you want):
27+
`pip install -e git://github.com/shotgunsoftware/python-api.git@v3.0.9#egg=shotgun_api3`
28+
29+
#### Master
30+
If you wish to install the current master, use the following command (Note that we try and keep master stable but it may contain issues. Tags are the current stable versions of the API):
2431
`pip install -e git://github.com/shotgunsoftware/python-api.git#egg=shotgun_api3`
2532

33+
#### requirements.txt
2634
If you're using pip with `requirements.txt`, add the following line:
2735
`-e git://github.com/shotgunsoftware/python-api.git#egg=shotgun_api3`
2836

0 commit comments

Comments
 (0)