gazu 0.10.24__tar.gz

gazu-0.10.24/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

gazu-0.10.24/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.2
+Name: gazu
+Version: 0.10.24
+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
+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.6
+Classifier: Programming Language :: Python :: 3.7
+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 :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+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.*, != 3.5.*, != 3.6.1, != 3.6.2
+License-File: LICENSE
+Requires-Dist: python-socketio[client]<6,>=5.11.0; python_version != "2.7"
+Requires-Dist: requests>=2.25.1
+Requires-Dist: Deprecated==1.2.15
+Requires-Dist: pywin32>=308; sys_platform == "win32" and python_version != "2.7"
+Provides-Extra: dev
+Requires-Dist: wheel; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: requests_mock; extra == "test"
+Requires-Dist: multipart; python_version >= "3.13" and extra == "test"
+Provides-Extra: lint
+Requires-Dist: autoflake==2.3.1; python_version >= "3.8" and extra == "lint"
+Requires-Dist: black==24.10.0; python_version >= "3.9" and extra == "lint"
+Requires-Dist: pre-commit==4.0.1; python_version >= "3.9" and extra == "lint"
+Dynamic: requires-python
+
+.. 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

gazu-0.10.24/README.rst

@@ -0,0 +1,117 @@
+.. 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

gazu-0.10.24/gazu/__init__.py

@@ -0,0 +1,113 @@
+from . import client as raw
+from . import cache
+from . import helpers
+
+try:
+    from . import events
+except ImportError:
+    pass
+
+from . import asset
+from . import casting
+from . import context
+from . import edit
+from . import entity
+from . import files
+from . import project
+from . import person
+from . import shot
+from . import sync
+from . import task
+from . import user
+from . import playlist
+from . import concept
+
+from .exception import (
+    AuthFailedException,
+    ParameterException,
+    NotAuthenticatedException,
+)
+from .__version__ import __version__
+
+
+def get_host(client=raw.default_client):
+    return raw.get_host(client=client)
+
+
+def set_host(url, client=raw.default_client):
+    raw.set_host(url, client=client)
+
+
+def log_in(
+    email,
+    password,
+    totp=None,
+    email_otp=None,
+    fido_authentication_response=None,
+    recovery_code=None,
+    client=raw.default_client,
+):
+    tokens = {}
+    try:
+        tokens = raw.post(
+            "auth/login",
+            {
+                "email": email,
+                "password": password,
+                "totp": totp,
+                "email_otp": email_otp,
+                "fido_authentication_response": fido_authentication_response,
+                "recovery_code": recovery_code,
+            },
+            client=client,
+        )
+    except (NotAuthenticatedException, ParameterException):
+        pass
+
+    if not tokens or (
+        "login" in tokens and tokens.get("login", False) == False
+    ):
+        raise AuthFailedException
+    else:
+        raw.set_tokens(tokens, client=client)
+    return tokens
+
+
+def send_email_otp(email, client=raw.default_client):
+    return raw.get("auth/email-otp", params={"email": email}, client=client)
+
+
+def log_out(client=raw.default_client):
+    tokens = {}
+    try:
+        raw.get("auth/logout", client=client)
+    except ParameterException:
+        pass
+    raw.set_tokens(tokens, client=client)
+    return tokens
+
+
+def refresh_access_token(client=raw.default_client):
+    return client.refresh_access_token()
+
+
+def get_event_host(client=raw.default_client):
+    return raw.get_event_host(client=client)
+
+
+def set_event_host(url, client=raw.default_client):
+    raw.set_event_host(url, client=client)
+
+
+def set_token(token, client=raw.default_client):
+    """
+    Store authentication token to reuse them for all requests.
+
+    Args:
+        new_tokens (dict): Tokens to use for authentication.
+    """
+
+    if isinstance(token, dict):
+        return raw.set_tokens(token, client=client)
+    else:
+        return raw.set_tokens({"access_token": token}, client=client)

gazu-0.10.24/gazu/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.10.24"