Installation

Minimum Requirements

  • Python 3.7

Note

Some features of the API are only supported by more recent versions of the ShotGrid server. These features are added to the Python API in a backwards compatible way so that existing scripts will continue to function as expected. Accessing a method that is not supported for your version of ShotGrid will raise an appropriate exception. In general, we attempt to document these where possible.

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.

See also

For more information on PYTHONPATH and using modules in Python, see http://docs.python.org/tutorial/modules.html

Note

Visit the introduction to the Python API to see an overview video of Setting Up Your Environment with the Python API.

Installing with pip

Installing the Master Branch From Github

If you wish to install the current master, use the following command:

pip install git+https://github.com/shotgunsoftware/python-api.git

Note

The master branch contains the latest revisions and while largely considered “stable” it is not an official packaged release.

Installing A specific Version From Github

To install a specific version of the package from Github, run the following command. This example installs the v3.0.26 tag, replace the version tag with the one you want:

pip install git+https://github.com/shotgunsoftware/python-api.git@v3.0.26

requirements.txt

If you’re using pip with requirements.txt, add the following line:

git+https://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.