Skip to main content

A client library for accessing Cirro

Project description

Cirro API Client

Low-level client for the Cirro API. Rather than using this package directly, we recommend using the Cirro SDK.

This Python package is automatically generated by the OpenAPI Python Client project.

Requirements.

Python 3.8+.

Installation & Usage

pip install

Via PyPI:

pip install cirro-api-client

You can also install it directory from the repository using:

pip install git+https://github.com/CirroBio/Cirro-client-python.git

Getting Started

Basic usage

import os
from typing import List
from pprint import pprint

from cirro_api_client import CirroApiClient, TokenAuth
from cirro_api_client.v1.api.projects import get_projects
from cirro_api_client.v1.models import Project
from cirro_api_client.v1.types import Response

# Create auth method, you can also extend the AuthMethod class
auth_method = TokenAuth(token=os.environ['TOKEN'])
# You can also use the RefreshableTokenAuth class
# auth_method = RefreshableTokenAuth(token_getter=lambda : os.environ['TOKEN'])

# Create a client
client = CirroApiClient(base_url="https://api.cirro.bio",
                        auth_method=auth_method)

# Call API endpoint, get list of projects
projects: List[Project] = get_projects.sync(client=client)
print("The response of get_projects:\n")
pprint(projects)
## or if you need more info (e.g. status_code)
resp: Response[List[Project]] = get_projects.sync_detailed(client=client)
projects = resp.parsed

Async usage

import os
from typing import List

from cirro_api_client import CirroApiClient, TokenAuth
from cirro_api_client.v1.api.projects import get_projects
from cirro_api_client.v1.models import Project

client = CirroApiClient(base_url="https://api.cirro.bio",
                        auth_method=TokenAuth(token=os.environ['TOKEN']))

# async method
async with client as client:
    projects: List[Project] = await get_projects.asyncio(client=client)

Advanced usage

There are more settings on the generated CirroApiClient class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying httpx.Client or httpx.AsyncClient (depending on your use-case):

import os
from cirro_api_client import CirroApiClient, TokenAuth

def log_request(request):
    print(f"Request event hook: {request.method} {request.url} - Waiting for response")

def log_response(response):
    request = response.request
    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")

client = CirroApiClient(
    base_url="https://api.cirro.bio",
    auth_method=TokenAuth(token=os.environ['TOKEN']),
    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
)

# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()

You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):

import os
import httpx
from cirro_api_client import CirroApiClient, TokenAuth

client = CirroApiClient(base_url="https://api.cirro.bio",
                        auth_method=TokenAuth(token=os.environ['TOKEN']))

# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
client.set_httpx_client(httpx.Client(base_url="https://api.cirro.bio", proxies="http://localhost:8030"))

Developer information

Re-generate the API client by running:

openapi-python-client update --url https://dev.cirro.bio/openapi/cirro-data-latest.yml --config config.yml --custom-template-path=templates/

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

cirro_api_client-0.2.1.tar.gz (66.2 kB view details)

Uploaded Source

Built Distribution

cirro_api_client-0.2.1-py3-none-any.whl (221.5 kB view details)

Uploaded Python 3

File details

Details for the file cirro_api_client-0.2.1.tar.gz.

File metadata

  • Download URL: cirro_api_client-0.2.1.tar.gz
  • Upload date:
  • Size: 66.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for cirro_api_client-0.2.1.tar.gz
Algorithm Hash digest
SHA256 548df4a533db5ac910b2d1c2f2e6a03b57f82ec2321860ebec6a29ca8f72f804
MD5 eff6590709f7b1aa20bd24a9e47f1d77
BLAKE2b-256 d2c2904793f3f0381092cfbf91261314a824915627a7a7a10fa24da923ba8a15

See more details on using hashes here.

File details

Details for the file cirro_api_client-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: cirro_api_client-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 221.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for cirro_api_client-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b6f96e8d904f0337d5e57914bfac3969bb0b9c1fe23e17a5b7679d7413635274
MD5 66add24a47af501a6461cd7f0c2a1f5c
BLAKE2b-256 3c06d6a87c779ef1813a9a371d9510c8d46d683ff71eb6bb11d3e62d1489cee0

See more details on using hashes here.

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