Metadata-Version: 2.1
Name: zammadoo
Version: 0.1.0
Summary: an object-oriented REST API client for zammad
Home-page: https://github.com/flashdagger/zammadoo
License: MIT
Keywords: zammad
Author: Marcel Kuszak
Author-email: marcel.kuszak@gmx.de
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: requests (>=2.31,<3.0)
Project-URL: Documentation, https://zammadoo.readthedocs.io/
Project-URL: Repository, https://github.com/flashdagger/zammadoo.git
Description-Content-Type: text/x-rst

========
zammadoo
========

.. image:: https://img.shields.io/pypi/l/ansicolortags.svg
        :target: https://pypi.python.org/pypi/ansicolortags/
        :alt: PyPI license

.. image:: https://readthedocs.org/projects/zammadoo/badge/?version=latest
        :target: https://zammadoo.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


an object-oriented REST API client for Zammad


Real life examples
------------------

.. code-block:: python

    from zammadoo import Client

    client = Client("https://myhost.com/api/v1/", username="<username>", password="<mysecret>")

    # I have a new ticket with id 17967 and I need to download the attachment file
    path = client.tickets(17967).articles[0].attachments[0].download()
    print(f"The downloaded file is {path}")

    # I need to close all tickets with the tag "deprecated" and remove the tag
    for ticket in client.tickets.search("tags:deprecated"):
        ticket.update(state="closed")
        ticket.remove_tags("deprecated")


design principles
-----------------

Zammadoo provides a fluent workflow. Since the provided resources are wrapped in its own type
your IDE can show you many of the available properties and methods.

