zammadoo 0.3.0.post0

an object-oriented REST API client for zammad

zammadoo

An object-oriented REST API client for the Zammad helpdesk sytem.

Note

Not to be confused with “Zammadoo” - a registered trademark and social networking app for leisure activities.

Find the full documentation under https://zammadoo.readthedocs.io.

Real life examples

from zammadoo import Client

client = Client("https://myhost.com/api/v1/", http_auth=("<username>", "<mysecret>"))
# or use an API token created via https://myhost.com/#profile/token_access
client = Client("https://myhost.com/api/v1/", http_token="<token>")

# I have a new ticket with id 17967 and 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 append a new ticket article with attached files
client.ticket(17967).create_article("Server down again. See logfiles.", files=["kern.log", "syslog"])

# I want 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

This library provides a fluent workflow. Since the resources are wrapped in its own type, your IDE can show you many of the available properties and methods. Furthermore you can ensure type safety with Python’s static type checkers like mypy.