Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
This repository was archived by the owner on Aug 22, 2019. It is now read-only.

talonrenaud/python-api

Open more actions menu
 
 

Repository files navigation

CLOSING THIS REPO SINCE SHOTGUN NOW SUPPORTS PYTHON3, THANKS !

VFX Platform Reference Documentation Build Status Linux Build status Windows Coverage Status Linting

Shotgun Python API - Unofficial (Python3.6+)

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 (support@shotgunsoftware.com)

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

Minimum Requirements

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

High Performance Requirements

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

Documentation

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

Some useful direct links:

Changelog

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

Tests

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.

About

A Python-based API for accessing Shotgun.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 90.4%
  • C 9.5%
  • Other 0.1%
Morty Proxy This is a proxified and sanitized view of the page, visit original site.