issabel-sdk 0.2.0

A Python client for the Issabel PBX REST API (pbxapi). Supports dynamic CRUD for all 40+ resources, batch provisioning with a single final reload, and a full Asterisk Manager Interface (AMI) wrapper.

Features

• Dynamic method generation — Automatic CRUD for all PBX resources (get_, create_, update_, delete_).
• Batch provisioning — with client.batch(): runs N write operations with zero per-call reloads; one manager/reload fires automatically at the end.
• AMI wrapper (client.manager) — All 18 Asterisk Manager actions: originate, queuestatus, dbget, dbput, hangup, reload, and more.
• Automatic token renewal — Detects HTTP 401 and legacy {"status": "expired"} responses and renews transparently.
• Read-only guards — NotImplementedError raised client-side for write attempts on read-only resources.
• Configurable timeout — All HTTP calls share a single timeout setting.
• Context manager — with IssabelClient(...) as client: closes the session on exit.
• SSL support — Configurable certificate verification (self-signed certs common on PBX appliances).

Installation

pip install issabel-sdk

Or from source:

git clone https://gitlab.com/libandpackages/issabel-sdk.git
cd issabel-sdk
pip install -e .[dev]

Quick Start

from issabel_client import IssabelClient

with IssabelClient("your-pbx-ip", use_ssl=True, verify_ssl=False) as client:
    client.authenticate("admin", "yourpassword")

    # List all extensions
    extensions = client.get_extensions()

    # Create one with immediate reload (default)
    client.create_extensions({"extension": "2000", "name": "John Doe", "secret": "pswd123"})

    # Batch provisioning — single reload at the end
    with client.batch():
        for ext in range(3001, 3100):
            client.create_extensions({"extension": str(ext), "name": f"User {ext}", "secret": "s3cr3t"})
    # ↑ Asterisk reloaded exactly once here

    # AMI: originate a call
    client.manager.originate(channel="SIP/1001", extension="1002", context="from-internal", priority=1)

    # AMI: reload Asterisk manually
    client.manager.reload()

Documentation

Full usage guide, payload schemas, and the complete resource catalogue are in docs/documentation.md.

Examples

Ready-to-run scripts are in the examples/ directory:

• example_usage.py

Contributing

Pull Requests are welcome at gitlab.com/libandpackages/issabel-sdk. Please run pytest and flake8 before submitting.

Resource Capabilities

License

MIT — see LICENSE.