Skip to main content

An async client for Gundi's API

Project description

Gundi Client

Introduction

Gundi, a.k.a "The Portal" is a platform to manage integrations. The gundi-client is an async python client to interact with Gundi's REST API.

Installation

pip install gundi-client

Usage

from gundi_client import PortalApi
import httpx

# You can use it as an async context-managed client
async with PortalApi() as portal:
   try:
    response = await portal.get_outbound_integration_list(
        session=session, inbound_id=str(inbound_id), device_id=str(device_id)
    )
    except httpx.RequestError as e:
        logger.exception("Request Error")   
        ...
    except httpx.TimeoutException as e:
        logger.exception("Request timed out")
        ...
    except httpx.HTTPStatusError as e:
        logger.exception("Response returned error")
    else:
        # response contains a list configs as dicts
        for integration in response:  
            ...
   ...

# Or create an instance and close the client explicitly later
portal = PortalApi()
try:
    response = await portal.get_outbound_integration_list(
        session=session, inbound_id=str(inbound_id), device_id=str(device_id)
    )
    except httpx.RequestError as e:
        logger.exception("Request Error")   
        ...
    except httpx.TimeoutException as e:
        logger.exception("Request timed out")
        ...
    except httpx.HTTPStatusError as e:
        logger.exception("Response returned error")
    else:
        # response contains a list configs as dicts
        for integration in response:  
            ...
   ...
   await portal.close()  # Close the session used to send requests to ER API

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gundi_client-1.0.3.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

gundi_client-1.0.3-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file gundi_client-1.0.3.tar.gz.

File metadata

  • Download URL: gundi_client-1.0.3.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for gundi_client-1.0.3.tar.gz
Algorithm Hash digest
SHA256 18b3626b63352e5af1d34626828dd5a88e57b7a584dde58a8a0803e2b6c0ca9c
MD5 f5e522b2d669bea500f2bf70f951f449
BLAKE2b-256 67060e926ede2ce4df4ef556d36100153e33c5db0008920dea77206f7eb3b4f8

See more details on using hashes here.

Provenance

File details

Details for the file gundi_client-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for gundi_client-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f930c478ae0df4cd4c0cceefc499180d6e609ee688c22c3cda75c98abe2a6179
MD5 cb87049dc3d9c08ef11881416e16b48e
BLAKE2b-256 da74520faf4aaee8ef218d4ebec59f190d494c2c5fbe3cd0d9c0b4817933c409

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page