sqi-submitter

DCC submitter framework for sqi — a distributed task and render farm manager.

sqi-submitter is a Python framework for building DCC (Digital Content Creation) integrations on top of sqi-sdk. It provides Qt-based UI components, host adapters for Maya, Houdini, Nuke, and Blender, and a foundation for submitting OpenJD job templates to an sqi farm directly from within your application.

Installation

pip install sqi-submitter              # core (requires sqi-sdk)
pip install 'sqi-submitter[qt]'        # + PySide6 for standalone UI

For development (run from clients/submitter/):

pip install -e ../python -e '.[dev]'   # local sqi-sdk + submitter with test & lint tools

The same checks CI runs (split there across three jobs), as one local chain — every stage must pass before a PR:

ruff format --check . && ruff check . && mypy src && mypy --python-version=3.13 tests && pytest -q

mypy --python-version=3.13 tests is not optional: pyproject.toml scopes mypy to src, so running mypy src alone misses type errors in test files that will still fail the PR.

Authentication

When the target sqi-server has auth.enabled=true (see docs/auth.md), a SubmitterSession needs an API key to authenticate headlessly. It resolves one in this order: the api_key argument passed to SubmitterSession, then the $SQI_API_KEY environment variable, then the api_key value in ~/.sqi/submitter.json (sqi_submitter.core.session.resolve_api_key). Whatever is found is forwarded to SqiClient as the Bearer token. Issue a key for yourself via POST /api/v1/api-keys or the web Admin → API Keys page — see docs/auth.md for how keys work.

Quick start

Open the standalone dialog (needs the qt extra, or a DCC-bundled PySide):

sqi-submit --server http://localhost:8080

Inside a DCC, wire the host's launch glue per docs/dcc-submitters.md.

Testing

Use the fake_host_module fixture to inject mock DCC modules:

def test_with_maya(fake_host_module):
    maya_cmds = fake_host_module("maya.cmds")
    # Your adapter code now sees maya.cmds in sys.modules

Documentation

Full reference and integration guides: docs/dcc-submitters.md.

License

AGPL-3.0-or-later. See the repository root for the full license text.

Project links

Data verified by PyPI on Aug 19, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for uberware from gravatar.com uberware

Credits

Author: Robin Scher

Maintainer: Uberware Inc.

GitHub Statistics

Data verified by PyPI on Aug 19, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

AGPL-3.0-or-later
View SPDX License List

Requires

Python >=3.9

Provides Extra

dev qt

Tags

blender houdini maya nuke openjd render-farm sqi vfx

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqi_submitter-0.3.0.tar.gz (57.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqi_submitter-0.3.0-py3-none-any.whl (50.4 kB view details)

Uploaded Python 3

File details

Details for the file sqi_submitter-0.3.0.tar.gz.

File metadata

  • Download URL: sqi_submitter-0.3.0.tar.gz
  • Upload date:
  • Size: 57.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sqi_submitter-0.3.0.tar.gz
Algorithm Hash digest
SHA256 9a4a5e12f55cc00c25e28e24ed03b1b6f26b5d1a44eab55d9354c0fa8322f8a7
MD5 259c7e65aae1a0671a0091744367fe0b
BLAKE2b-256 beee9c19d9e73891883cbe0eaf90d3797fe8d552f75d9a2d09094395ac0bbeeb

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqi_submitter-0.3.0.tar.gz:

Publisher: release.yml on uberware/sqi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sqi_submitter-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: sqi_submitter-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 50.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sqi_submitter-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f3807d5b1b08d65f3fd7bf9a156d8b2d8b31a5117397591b12d2debd7b49f90
MD5 4282eb2218516e916132cca1991fb0db
BLAKE2b-256 565b8a0c40b027d860189d5494604452b02727fbe69589c1ce3b90b59757dcc7

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqi_submitter-0.3.0-py3-none-any.whl:

Publisher: release.yml on uberware/sqi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.0

2 files

Pre-release

0.1.0.dev0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page