zammadoo

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

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.

Release files for zammadoo 0.3.0.post0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for zammadoo 0.3.0.post0
File	Interpreter	ABI	Platform	Reset
zammadoo-0.3.0.post0-py3-none-any.whl 27.4 kB Jul 25, 2024	Python 3	none	any	Details

Release files / zammadoo-0.3.0.post0-py3-none-any.whl

Download URL	zammadoo-0.3.0.post0-py3-none-any.whl
Size	27.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b6aa132c36d368fa72a766d2b7e973fec94e09716758b9b49ca6eeabdab16924`
BLAKE2b-256 checksum How to use checksums	`3875f514845984852660a0e94510d229885f1bed4fe88ebb45311b2a36a28099`
Upload date	Jul 25, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.4`