https://github.com/cgwire/gazu

Python Client for the Kitsu API (Zou)
https://github.com/cgwire/gazu

Last synced: 3 months ago
JSON representation

Python Client for the Kitsu API (Zou)

• Host: GitHub
• URL: https://github.com/cgwire/gazu
• Owner: cgwire
• License: lgpl-3.0
• Created: 2017-03-25T23:47:00.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-30T12:48:25.000Z (3 months ago)
• Last Synced: 2024-07-30T22:26:25.611Z (3 months ago)
• Language: Python
• Homepage: https://gazu.cg-wire.com
• Size: 6.73 MB
• Stars: 82
• Watchers: 12
• Forks: 55
• Open Issues: 11
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. figure:: https://zou.cg-wire.com/kitsu.png

   :alt: Kitsu Logo

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.

|CI badge| |Discord| |Downloads|

Quickstart

----------

Install Gazu in your application environment via pip:

.. code:: bash

    pip install gazu

The client requires a few extra configurations before being used. It

needs to know where is located the API server and to log in:

.. code:: python

    import gazu

    gazu.set_host("https://zou-server-url/api")

    gazu.log_in("[email protected]", "password")

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

::

    projects = gazu.project.all_open_projects()

Documentation

-------------

Documentation and specification are available on a dedicated website:

`https://gazu.cg-wire.com `__

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 :

.. code:: bash

    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

-------------

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.

|CGWire Logo|

.. |CI badge| image:: https://github.com/cgwire/gazu/actions/workflows/ci.yml/badge.svg

   :target: https://github.com/cgwire/gazu/actions/workflows/ci.yml

.. |Discord| image:: https://badgen.net/badge/icon/discord?icon=discord&label

   :target: https://discord.com/invite/VbCxtKN

.. |CGWire Logo| image:: https://zou.cg-wire.com/cgwire.png

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

.. |Downloads| image:: https://static.pepy.tech/personalized-badge/gazu?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads

   :target: https://pepy.tech/project/gazu