.. 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 <https://zou.cg-wire.com>`__. 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("user@yourdomain.com", "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 <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 <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>`__.
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 <https://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
Raw data
{
"_id": null,
"home_page": "https://gazu.cg-wire.com/",
"name": "gazu",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.1,!=3.6.2,>=2.7",
"maintainer_email": null,
"keywords": "cg, production, asset manager, asset, shot, tasks, tracking",
"author": "CG Wire",
"author_email": "frank@cg-wire.com",
"download_url": "https://files.pythonhosted.org/packages/3f/28/f8f83a7bd810fbf0c6ac4afc8670716c9c9f34c613b87759b603b3792f4b/gazu-0.10.21.tar.gz",
"platform": null,
"description": ".. figure:: https://zou.cg-wire.com/kitsu.png\n :alt: Kitsu Logo\n\n\nGazu, Python client for the Kitsu API\n=====================================\n\nThe Kitsu Python client allows you to fetch data easily from the Kitsu\ncollaboration platform. With Gazu, you bring assets and shots data into your\npipeline tools. It comes with extra features such as preview publishing and \nevent stream listening.\n\nIt is made to be used with the `Kitsu API <https://zou.cg-wire.com>`__. It\nrequires an up-and-running instance of Kitsu to run correctly.\n\n|CI badge| |Discord| |Downloads|\n\nQuickstart\n----------\n\nInstall Gazu in your application environment via pip:\n\n.. code:: bash\n\n pip install gazu\n\nThe client requires a few extra configurations before being used. It\nneeds to know where is located the API\u00a0server and to log in:\n\n.. code:: python\n\n import gazu\n\n gazu.set_host(\"https://zou-server-url/api\")\n gazu.log_in(\"user@yourdomain.com\", \"password\")\n\nLet's finish with an example. Fetch all the open projects:\n\n::\n\n projects = gazu.project.all_open_projects()\n\n\nDocumentation\n-------------\n\nDocumentation and specification are available on a dedicated website:\n\n`https://gazu.cg-wire.com <https://gazu.cg-wire.com>`__\n\n\nProjects using the Kitsu client\n-------------------------------\n\nOur community-built open-source tools connect your content creation tools to\nyour Kitsu instance. They are listed below:\n\n* `Qtazu <https://github.com/Colorbleed/qtazu>`__: Qt Widgets such as a login\n modal.\n* `Nagato <https://github.com/eaxum/nagato>`__: Publishing and file versioning\n for Blender.\n* `Bamboo <https://github.com/nervYu/Bamboo>`__: Pyside2\u00a0widgets to publish\n previews to Kitsu.\n* `Gazu Publisher <https://github.com/cgwire/gazu-publisher>`__: Our work in\n progress publisher tool.\n\n\nContributions\n-------------\n\nAll contributions are welcome as long as they respect the `C4\ncontract <https://rfc.zeromq.org/spec:42/C4>`__.\n\nThe code must follow the pep8 convention.\n\nYou can use the pre-commit hook for Black (a Python code formatter) before committing :\n\n.. code:: bash\n\n pip install pre-commit\n pre-commit install\n\n\nContributors\n------------\n\n* @aboellinger (Xilam)\n* @BigRoy (Colorbleed)\n* @col-one (Allegorithmic)\n* @EvanBldy (CGWire) - *maintainer*\n* @flablog (Les F\u00e9es Sp\u00e9ciales)\n* @frankrousseau (CGWire) - *maintainer*\n* @kguyaux\n* @LedruRollin (Xilam)\n* @g-Lul (TNZPV)\n* @jdrese (HEAJ)\n* @pcharmoille (Unit Image)\n* @tokejepsen (Bumpybox)\n* @tpodeva\n\nAbout authors\n-------------\n\nKitsu 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.\n\nVisit `cg-wire.com <https://cg-wire.com>`__ for more information.\n\n|CGWire Logo|\n\n.. |CI badge| image:: https://github.com/cgwire/gazu/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/cgwire/gazu/actions/workflows/ci.yml\n.. |Discord| image:: https://badgen.net/badge/icon/discord?icon=discord&label\n :target: https://discord.com/invite/VbCxtKN\n.. |CGWire Logo| image:: https://zou.cg-wire.com/cgwire.png\n :target: https://cg-wire.com\n.. |Downloads| image:: https://static.pepy.tech/personalized-badge/gazu?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads\n :target: https://pepy.tech/project/gazu\n",
"bugtrack_url": null,
"license": "GNU Library or Lesser General Public License (LGPL)",
"summary": "Gazu is a client for Zou, the API to store the data of your CG production.",
"version": "0.10.21",
"project_urls": {
"Homepage": "https://gazu.cg-wire.com/"
},
"split_keywords": [
"cg",
" production",
" asset manager",
" asset",
" shot",
" tasks",
" tracking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61760a77d480fc89729b7e8dc23c9db50634179fd1a6c5a6afb5a0fd601d8c91",
"md5": "4bd613b849980ab6e69743ea7ebb495f",
"sha256": "113974b2faadf159974e6f6ca1d4b4ac074e86436fc480ffc5f143816cc6aa88"
},
"downloads": -1,
"filename": "gazu-0.10.21-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bd613b849980ab6e69743ea7ebb495f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.1,!=3.6.2,>=2.7",
"size": 53374,
"upload_time": "2024-12-13T14:55:33",
"upload_time_iso_8601": "2024-12-13T14:55:33.312788Z",
"url": "https://files.pythonhosted.org/packages/61/76/0a77d480fc89729b7e8dc23c9db50634179fd1a6c5a6afb5a0fd601d8c91/gazu-0.10.21-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f28f8f83a7bd810fbf0c6ac4afc8670716c9c9f34c613b87759b603b3792f4b",
"md5": "05f62c14f82b749af14d4a2ac5285886",
"sha256": "ecdd3f9deac6cd41ce1e4178da1f28d9ccc1179475e3039fdf28fed40c42d410"
},
"downloads": -1,
"filename": "gazu-0.10.21.tar.gz",
"has_sig": false,
"md5_digest": "05f62c14f82b749af14d4a2ac5285886",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.1,!=3.6.2,>=2.7",
"size": 72894,
"upload_time": "2024-12-13T14:55:36",
"upload_time_iso_8601": "2024-12-13T14:55:36.089570Z",
"url": "https://files.pythonhosted.org/packages/3f/28/f8f83a7bd810fbf0c6ac4afc8670716c9c9f34c613b87759b603b3792f4b/gazu-0.10.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 14:55:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gazu"
}
JSON