Gazu, Python client for the Kitsu API
The Kitsu Python client allows you to fetch data easily from the Kitsu collaboration platform. With Gazu, you bring assets and shots data into your pipeline tools. It comes with extra features such as preview publishing and event stream listening.
It is made to be used with the Kitsu API. It requires an up-and-running instance of Kitsu to run correctly.
Quickstart
Install Gazu in your application environment via pip:
pip install gazuFor the asynchronous API (gazu.aio), install the async extra:
pip install gazu[async]The client requires a few extra configurations before being used. It needs to know where is located the API server and to log in:
import gazu
gazu.set_host("https://zou-server-url/api")
gazu.log_in("user@yourdomain.com", "password")For scripts, DCC integrations and automation, prefer a bot token over user credentials:
gazu.set_host("https://zou-server-url/api")
gazu.set_token("your-bot-jwt-token")Let’s finish with an example. Fetch all the open projects:
projects = gazu.project.all_open_projects()
CLI
Gazu ships with an optional command-line interface. Install it with:
pip install gazu[cli]Then log in and start querying your Kitsu instance from the terminal:
gazu-cli login --host https://zou-server-url/api
gazu-cli projects
gazu-cli assets --project "My Project"
gazu-cli my-tasks
gazu-cli shots --project "My Project" --sequence SEQ01
gazu-cli comment --task <task-id> --status wip --message "Started lighting"Use gazu-cli --help to see all available commands. Add --json to any command to get machine-readable JSON output. You can also set the GAZU_PROJECT environment variable to avoid repeating --project.
Documentation
Documentation and specification are available on a dedicated website:
Projects using the Kitsu client
Our community-built open-source tools connect your content creation tools to your Kitsu instance. They are listed below:
Qtazu: Qt Widgets such as a login modal.
Nagato: Publishing and file versioning for Blender.
Bamboo: Pyside2 widgets to publish previews to Kitsu.
Gazu Publisher: Our work in progress publisher tool.
Contributions
All contributions are welcome as long as they respect the C4 contract.
The code must follow the pep8 convention.
You can use the pre-commit hook for Black (a Python code formatter) before committing :
pip install pre-commit
pre-commit installContributors
@aboellinger (Xilam)
@BigRoy (Colorbleed)
@col-one (Allegorithmic)
@EvanBldy (CGWire) - maintainer
@flablog (Les Fées Spéciales)
@frankrousseau (CGWire) - maintainer
@kguyaux
@LedruRollin (Xilam)
@g-Lul (TNZPV)
@jdrese (HEAJ)
@pcharmoille (Unit Image)
@tokejepsen (Bumpybox)
@tpodeva
About authors
Kitsu is written by CGWire, a company based in France. We help animation and VFX studios to collaborate better through efficient tooling. We already work with more than 70 studios around the world.
Visit cg-wire.com for more information.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gazu-1.2.2.tar.gz.
File metadata
- Download URL: gazu-1.2.2.tar.gz
- Upload date:
- Size: 127.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b52d37c1539411d3145032878eeb59b36b7be8ae196333a992d26ff441c80c72
|
|
| MD5 |
2c32f1213a09309aa0ae466ffbd23b3a
|
|
| BLAKE2b-256 |
337c5de82f91e4762a8b6524e575bb078e009c937858de73379ecd1a04042906
|
Provenance
The following attestation bundles were made for gazu-1.2.2.tar.gz:
Publisher:
release.yml on cgwire/gazu
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gazu-1.2.2.tar.gz -
Subject digest:
b52d37c1539411d3145032878eeb59b36b7be8ae196333a992d26ff441c80c72 - Sigstore transparency entry: 2615418071
- Sigstore integration time:
-
Permalink:
cgwire/gazu@c2505e1201754590581685615cf261485a5c933e -
Branch / Tag:
refs/tags/v1.2.2 - Owner: https://github.com/cgwire
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@c2505e1201754590581685615cf261485a5c933e -
Trigger Event:
push
-
Statement type:
File details
Details for the file gazu-1.2.2-py3-none-any.whl.
File metadata
- Download URL: gazu-1.2.2-py3-none-any.whl
- Upload date:
- Size: 93.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
69ba0b02a18662ca9778e0844f0c66150bfedbae26b0111ea177bb5696fdd3fa
|
|
| MD5 |
5a8466f09bf051423d5b10a4aaa98ec9
|
|
| BLAKE2b-256 |
949a1d8a726af6349a315955bf25f7231a842ac98919f835dd08afebf5c438ee
|
Provenance
The following attestation bundles were made for gazu-1.2.2-py3-none-any.whl:
Publisher:
release.yml on cgwire/gazu
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gazu-1.2.2-py3-none-any.whl -
Subject digest:
69ba0b02a18662ca9778e0844f0c66150bfedbae26b0111ea177bb5696fdd3fa - Sigstore transparency entry: 2615418109
- Sigstore integration time:
-
Permalink:
cgwire/gazu@c2505e1201754590581685615cf261485a5c933e -
Branch / Tag:
refs/tags/v1.2.2 - Owner: https://github.com/cgwire
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@c2505e1201754590581685615cf261485a5c933e -
Trigger Event:
push
-
Statement type:
