Metadata-Version: 2.1
Name: gazu
Version: 0.8.23
Summary: Gazu is a client for Zou, the API to store the data of your CG production.
Home-page: https://gazu.cg-wire.com/
Author: CG Wire
Author-email: frank@cg-wire.com
License: GNU Library or Lesser General Public License (LGPL)
Keywords: cg,production,asset manager,asset,shot,tasks,tracking
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Multimedia :: Graphics
Requires-Python: >2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
License-File: LICENSE
Requires-Dist: deprecated (==1.2.13)
Requires-Dist: requests (==2.26.0) ; python_version != "3.5"
Requires-Dist: python-socketio[client] (==4.2.1) ; python_version == "2.7"
Requires-Dist: requests (==2.25.1) ; python_version == "3.5"
Requires-Dist: python-socketio[client] (==4.6.1) ; python_version >= "3.5"
Provides-Extra: dev
Requires-Dist: wheel ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov (==2.12.1) ; extra == 'test'
Requires-Dist: requests-mock (==1.9.3) ; extra == 'test'
Requires-Dist: pytest (==4.6.11) ; (python_version == "2.7") and extra == 'test'
Requires-Dist: pre-commit (==1.21.0) ; (python_version == "2.7" or python_version == "3.5") and extra == 'test'
Requires-Dist: pytest (==6.1.2) ; (python_version == "3.5") and extra == 'test'
Requires-Dist: pytest (==6.2.5) ; (python_version >= "3.6") and extra == 'test'
Requires-Dist: pre-commit (==2.15.0) ; (python_version >= "3.6") and extra == 'test'

.. figure:: https://gazu.cg-wire.com/_images/gazu.png
   :alt: 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 <https://zou.cg-wire.com>`__. 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:

.. code:: bash

    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:

.. code:: python

    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 <https://gazu.cg-wire.com>`__ to see
what features are available!

Documentation
-------------

Documentation is available on a dedicated website:

`https://gazu.cg-wire.com <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 <https://github.com/Colorbleed/qtazu>`__: Qt Widgets such as a login
  modal.
* `Nagato <https://github.com/eaxum/nagato>`__: Publishing and file versioning
  for Blender.
* `Bamboo <https://github.com/nervYu/Bamboo>`__: Pyside2 widgets to publish
  previews to Kitsu.
* `Gazu Publisher <https://github.com/cgwire/gazu-publisher>`__: Our work in
  progress publisher tool.


Contributions
-------------

All contributions are welcome as long as they respect the `C4
contract <https://rfc.zeromq.org/spec:42/C4>`__.

Code must follow the pep8 convention.

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

.. 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
-------------

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 <https://cg-wire.com>`__ for more information.

|CGWire Logo|

.. |Build status| image:: https://api.travis-ci.com/cgwire/gazu.svg?branch=master
   :target: https://app.travis-ci.com/cgwire/gazu
.. |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


