/gazu

Python Client for the Kitsu API (Zou)

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

Gazu Logo

Gazu, Python client for the Kitsu API

Gazu is a Python client that allows to fetch data easily from your animation production environment (tasks, shots, assets, casting and dependencies). More than giving access to data, it allows to perform operations like generating file paths, marking a task as started, setting a thumbnail on a shot and many more. To make it short, it will boost your pipeline tools!

It is made to be used with the Zou API. It requires an up and running instance of Zou to run properly.

Build status Discord Downloads

Quickstart

Install Gazu in your application environment via pip:

pip install gazu

The client requires a few extra configuration 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")

Let's finish with an example. Fetch all the open projects:

projects = gazu.project.all_open_projects()

Then jump to the documentation to see what features are available!

Documentation

Documentation is available on a dedicated website:

https://gazu.cg-wire.com

Projects based on Gazu

Our community built open-source tools to 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.

Code must follow the pep8 convention.

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

pip install pre-commit
pre-commit install

Contributors

  • @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

Gazu is written by CGWire, a company based in France. We help teams of animation studios to collaborate better. We provide tools to more than 50 studios spread all around the world.

On the technical side, we apply software craftmanship principles as much as possible. We love coding and consider that strong quality and good developer experience matter a lot.

Visit cg-wire.com for more information.

CGWire Logo