shotgun-api3

What it is and what it does

This is the official Python client library maintained by Autodesk for Flow Production Tracking (formerly Shotgun), a web-based production tracking and asset management system used in media and entertainment workflows. It provides direct programmatic access to production data—assets, shots, tasks, versions, and custom fields—via HTTP-based API calls, allowing developers to build integrations, automation scripts, and custom tools that read from and write to a Flow Production Tracking instance.

The package is production-stable (Development Status 5) with zero runtime dependencies, making it lightweight to install and integrate into existing Python environments. It supports modern Python versions (3.9 through 3.13) and is actively maintained by Autodesk, with recent releases and a public GitHub repository. Users must provide server credentials (URL, script name, and API key) to authenticate; the library handles the HTTP communication and response parsing internally.

Use it for:

• Automate asset ingestion and metadata updates in a production tracking database from external tools or scripts.
• Build custom reporting dashboards that query production data (shots, assets, tasks, versions) for status and scheduling.
• Integrate Flow Production Tracking with VFX or animation pipelines to sync task assignments and approval statuses.
• Export production data for analytics, archival, or migration to other systems.
• Create batch operations to update multiple records (e.g., bulk status changes or field assignments) programmatically.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Official Python API client for Autodesk Flow Production Tracking, enabling programmatic access to production tracking data and integration with external tools.

Yes. This is the official, actively maintained client for Flow Production Tracking with low install friction, no external dependencies, and broad Python version support. It carries a permissive BSD license and has no known vulnerabilities. Install it if you need to integrate with or automate a Flow Production Tracking instance; it is the standard choice for that use case.

Install

shotgun-api3 on PyPI

pip install shotgun-api3

uv add shotgun-api3

poetry add shotgun-api3

Installing shotgun-api3

Before you install

Low install friction with no runtime dependencies. Actively maintained by Autodesk with a recent release (8 days ago) and consistent updates. Supports current Python versions (3.9–3.13).

License in practice

BSD 2-Clause license with permissive terms. Includes portions of Python standard library xml-rpc code under separate BSD-style permission. No restrictions on commercial use or redistribution.

Quickstart

pip install shotgun-api3

from shotgun_api3 import Shotgun

sg = Shotgun('https://your-server.shotgunstudio.com', script_name='script_key', api_key='api_key')
results = sg.find('Asset', [], ['code', 'sg_status_list'])

Requires a Flow Production Tracking server instance and valid script credentials (server URL, script name, and API key) to authenticate and retrieve data.

Verify before relying

• Whether the package supports offline mode or local caching of production data.
• Performance characteristics when querying large datasets or complex filter hierarchies.
• Whether batch operations or transaction support is available for multi-record updates.

Package facts

Evidence: shotgun_api3-3.10.3-py2.py3-none-any.whl

Tags

More Front-Ends packages