httpx-gracedb Documentation

httpx-gracedb provides a generic REST API client for GraceDB and similar LIGO/Virgo API services. It uses the powerful httpx package for reliable and high-throughput HTTP connection pooling.

Quick Start

Install with pip:

pip install httpx-gracedb

API

httpx_gracedb Package

Classes

AsyncClient([url, token, username, ...])	Same as httpx_gracedb.Client but for async requests.
Client([url, token, username, password, ...])	A httpx.Client subclass that adds behaviors that are common to ligo.org REST API services such as that of GraceDB.

Class Inheritance Diagram

httpx_gracedb.auth Module

Classes

ClientAuthMixin([url, token, username, ...])

A mixin for httpx.Client to add support for all GraceDB authentication mechanisms.

Class Inheritance Diagram

httpx_gracedb.errors Module

Classes

AsyncClientErrorMixin(**kwargs)	A mixin for httpx.Client to raise exceptions for HTTP errors.
ClientErrorMixin(**kwargs)	A mixin for httpx.Client to raise exceptions for HTTP errors.

Class Inheritance Diagram

httpx_gracedb.file Module

Classes

ClientFileMixin(*[, auth, params, headers, ...])

A mixin for httpx.Client to add features for file uploads.

Class Inheritance Diagram

httpx_gracedb.user_agent Module

Classes

ClientUserAgentMixin(**kwargs)

A mixin for http.Client to add a User-Agent header.

Class Inheritance Diagram