Migration

Migrate Znuny integrations from otobo_znuny or the combined otobo-znuny package to pip install znuny.

Migration — Znuny Python SDK

If you previously used the combined otobo-znuny or otobo_znuny package for Znuny integrations, switch to the dedicated znuny package.

Install

pip install znuny

You do not need pip install otobo for Znuny-only projects.

Import changes

Before (deprecated)After (Znuny)
from otobo_znuny.clients.otobo_client import OTOBOZnunyClientfrom znuny import ZnunyClient
from otobo_znuny_python_client import OTOBOZnunyClientfrom znuny import ZnunyClient
OTOBOErrorfrom znuny import ZnunyError
from otobo import OTOBOClient (on Znuny)from znuny import ZnunyClient

Client rename

# Before
client = OTOBOZnunyClient(config)

# After
from znuny import ZnunyClient

client = ZnunyClient(config)

ClientConfig, ticket models, and async method names (create_ticket, search_tickets, …) stay the same.

CLI changes

LegacyZnuny
Combined setup CLIznuny-cli setup-system
setup-otobo-znuny-systemznuny-cli setup-system

Compatibility window

Legacy imports under otobo_znuny.* still work in 2.x but are deprecated. New Znuny code should use znuny only.

Further reading