Based of version: 3.0.38

Python3 support is becoming critical as we already converted a lot of code to preemptively support upcoming vfxplatform requirements and also allow proper use of PySide2. This is an attempt at converting the Shotgun Python API to Python3+. This version is not backward compatible, so please do not install on Python2+, it won't work.

Shotgun provides a simple Python-based API for accessing Shotgun and integrating with other tools. This is the official API that is maintained by Shotgun Software ([email protected])

The latest version can always be found at http://github.com/shotgunsoftware/python-api

• Shotgun server v2.4.12+.
• Python v3.6+.

* Install simplejson 2.1.6 (built in to Python3, no needed anymore)

Tutorials and detailed documentation about the Python API are available at http://developer.shotgunsoftware.com/python-api).

Some useful direct links:

• Installing
• Tutorials
• API Reference
• Data Types
• Filter Syntax

You can see the full history of the Python API on the documentation site.

Integration and unit tests are provided.

• All tests require the nose unit testing tools, and a tests/config file (you can copy an example from tests/example_config).
• Tests can be run individually like this: nosetest tests/test_client.py
• test_client and tests_unit use mock server interaction and do not require a Shotgun instance to be available (no modifications to tests/config are necessary).
• test_api and test_api_long do require a Shotgun instance, with a script key available for the tests. The server and script user values must be supplied in the tests/config file. The tests will add test data to your server based on information in your config. This data will be manipulated by the tests, and should not be used for other purposes.
• To run all of the tests, use the shell script run-tests.