Skip to main content

API to store and manage the data of your animation production

Project description

Kitsu Logo

Zou, the Kitsu API is the memory of your animation production

The Kitsu API allows to store and manage the data of your animation/VFX production. Through it, you can link all the tools of your pipeline and make sure they are all synchronized.

A dedicated Python client, Gazu, allows users to integrate Zou into the tools.

CI badge Downloads badge Discord badge

Features

Zou can:

  • Store production data, such as projects, shots, assets, tasks, and file metadata.

  • Track the progress of your artists

  • Store preview files and version them

  • Provide folder and file paths for any task

  • Import and Export data to CSV files

  • Publish an event stream of changes

Installation and Documentation

Installation of Zou requires the setup of third-party tools such as a database instance, so it is recommended to follow the documentation:

https://zou.cg-wire.com/

Specification: - https://api-docs.kitsu.cloud/

Contributing

Contributions are welcomed so long as the C4 contract is respected.

Zou is based on Python and the Flask framework.

You can use the pre-commit hook for Black (a Python code formatter) before committing:

pip install pre-commit
pre-commit install

If you use Claude Code (or another AI assistant that reads CLAUDE.md), copy CLAUDE.local.md.example to CLAUDE.local.md and adapt it to your local environment (virtualenv path, test database name, etc.). The CLAUDE.local.md file is gitignored and holds your local-only commands (test execution, migrations), while CLAUDE.md only documents code conventions shared by the whole team.

cp CLAUDE.local.md.example CLAUDE.local.md

Instructions for setting up a development environment are available in the documentation

Contributors

  • @aboellinger (Xilam/Spa)

  • @BigRoy (Colorbleed)

  • @EvanBldy (CGWire) - maintainer

  • @ex5 (Blender Studio)

  • @flablog (Les Fées Spéciales)

  • @frankrousseau (CGWire) - maintainer

  • @kaamaurice (Tchak)

  • @g-Lul (TNZPV)

  • @pilou (Freelancer)

  • @LedruRollin (Cube-Xilam)

  • @mathbou (Zag)

  • @manuelrais (TNZPV)

  • @NehmatH (CGWire)

  • @pcharmoille (Unit Image)

  • @Tilix4 (Normaal)

About authors

Kitsu is written by CGWire, a company based in France. We help with 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.

CGWire Logo

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

zou-1.0.58.tar.gz (624.9 kB view details)

Uploaded Source

Built Distribution

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

zou-1.0.58-py3-none-any.whl (803.6 kB view details)

Uploaded Python 3

File details

Details for the file zou-1.0.58.tar.gz.

File metadata

  • Download URL: zou-1.0.58.tar.gz
  • Upload date:
  • Size: 624.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for zou-1.0.58.tar.gz
Algorithm Hash digest
SHA256 e2bc601808a4dabb7d18a397b0aacc3fe910dfd467162efaf77e61ab5372871c
MD5 663e420ca0d05c822fda215b66e7b547
BLAKE2b-256 2a4c3752cf91771cecdd1bc4872cb8b518253cc68c075b2eafead0826b206eb7

See more details on using hashes here.

Provenance

The following attestation bundles were made for zou-1.0.58.tar.gz:

Publisher: ci.yml on cgwire/zou

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

File details

Details for the file zou-1.0.58-py3-none-any.whl.

File metadata

  • Download URL: zou-1.0.58-py3-none-any.whl
  • Upload date:
  • Size: 803.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for zou-1.0.58-py3-none-any.whl
Algorithm Hash digest
SHA256 79b8b65ae42f64c4ba4b535894485a212d6ab27804a46f923c9ee44b0ac2dee3
MD5 6a55b8ac1a80c8984c99dac7a274a48f
BLAKE2b-256 78449fa9d31d99b688f4335bb6f2286930e50ea70564cceaa506ef7b240032bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for zou-1.0.58-py3-none-any.whl:

Publisher: ci.yml on cgwire/zou

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page