Metadata-Version: 2.1
Name: zou
Version: 0.19.11
Summary: API to store and manage the data of your animation production
Home-page: https://zou.cg-wire.com
Author: CG Wire
Author-email: frank@cg-wire.com
License: GNU Affero General Public License v3
Keywords: animation,cg,asset,shot,api,cg production,asset management
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Multimedia :: Graphics
Requires-Python: >=3.8.1, <3.12
License-File: LICENSE
Requires-Dist: babel ==2.14.0
Requires-Dist: click ==8.1.7
Requires-Dist: discord.py ==2.3.2
Requires-Dist: email-validator ==2.1.1
Requires-Dist: ffmpeg-python ==0.2.0
Requires-Dist: fido2 ==1.1.2
Requires-Dist: flasgger ==0.9.7.1
Requires-Dist: flask-bcrypt ==1.0.1
Requires-Dist: flask-caching ==2.1.0
Requires-Dist: flask-fixtures ==0.3.8
Requires-Dist: flask-mail ==0.9.1
Requires-Dist: flask-principal ==0.4.0
Requires-Dist: flask-restful ==0.3.10
Requires-Dist: flask-sqlalchemy ==3.1.1
Requires-Dist: flask-fs2[s3,swift] ==0.7.23
Requires-Dist: flask-jwt-extended ==4.6.0
Requires-Dist: flask-migrate ==4.0.5
Requires-Dist: flask-socketio ==5.3.6
Requires-Dist: flask ==3.0.2
Requires-Dist: gazu ==0.10.0
Requires-Dist: gevent-websocket ==0.10.1
Requires-Dist: gevent ==24.2.1
Requires-Dist: gunicorn ==21.2.0
Requires-Dist: isoweek ==1.3.3
Requires-Dist: itsdangerous ==2.1.2
Requires-Dist: Jinja2 ==3.1.3
Requires-Dist: ldap3 ==2.9.1
Requires-Dist: matterhook ==0.2
Requires-Dist: meilisearch ==0.30.0
Requires-Dist: numpy ==1.24.4
Requires-Dist: opencv-python ==4.9.0.80
Requires-Dist: OpenTimelineIO ==0.15.0
Requires-Dist: orjson ==3.9.15
Requires-Dist: pillow ==10.2.0
Requires-Dist: psutil ==5.9.8
Requires-Dist: psycopg[binary] ==3.1.18
Requires-Dist: pyotp ==2.9.0
Requires-Dist: python-nomad ==2.0.0
Requires-Dist: python-slugify ==8.0.4
Requires-Dist: python-socketio ==5.11.1
Requires-Dist: pytz ==2024.1
Requires-Dist: redis ==5.0.2
Requires-Dist: requests ==2.31.0
Requires-Dist: rq ==1.16.0
Requires-Dist: slackclient ==2.9.4
Requires-Dist: sqlalchemy-utils ==0.41.1
Requires-Dist: sqlalchemy ==2.0.28
Requires-Dist: ua-parser ==0.18.0
Requires-Dist: werkzeug ==3.0.1
Provides-Extra: dev
Requires-Dist: wheel ; extra == 'dev'
Provides-Extra: lint
Requires-Dist: black ==24.2.0 ; extra == 'lint'
Requires-Dist: pre-commit ==3.6.2 ; (python_version >= "3.9") and extra == 'lint'
Provides-Extra: monitoring
Requires-Dist: prometheus-flask-exporter ==0.23.0 ; extra == 'monitoring'
Requires-Dist: pygelf ==0.4.2 ; extra == 'monitoring'
Requires-Dist: sentry-sdk ==1.40.6 ; extra == 'monitoring'
Provides-Extra: prod
Requires-Dist: gunicorn ; extra == 'prod'
Requires-Dist: gevent ; extra == 'prod'
Provides-Extra: test
Requires-Dist: fakeredis ==2.21.1 ; extra == 'test'
Requires-Dist: mixer ==7.2.2 ; extra == 'test'
Requires-Dist: pytest-cov ==4.1.0 ; extra == 'test'
Requires-Dist: pytest ==8.0.2 ; extra == 'test'

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

Specification:
- `https://api-docs.kitsu.cloud/ <https://api-docs.kitsu.cloud>`__

Contributing
------------

Contributions are welcomed so long as the `C4
contract <https://rfc.zeromq.org/spec:42/C4>`__ is respected.

Zou is based on Python and the `Flask <http://flask.pocoo.org/>`__
framework.

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

.. code:: bash

    pip install pre-commit
    pre-commit install

Instructions for setting up a development environment are available in
`the documentation <https://zou.cg-wire.com/development/>`__


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

|CGWire Logo|

.. |CI badge| image:: https://github.com/cgwire/zou/actions/workflows/ci.yml/badge.svg
   :target: https://github.com/cgwire/zou/actions/workflows/ci.yml
.. |Gitter badge| image:: https://badges.gitter.im/cgwire/Lobby.png
   :target: https://gitter.im/cgwire/Lobby
.. |CGWire Logo| image:: https://zou.cg-wire.com/cgwire.png
   :target: https://cgwire.com
.. |Downloads badge| image:: https://static.pepy.tech/personalized-badge/zou?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads
   :target: https://pepy.tech/project/zou
.. |Discord badge| image:: https://badgen.net/badge/icon/discord?icon=discord&label
   :target: https://discord.com/invite/VbCxtKN
