Python client API reference#

rubin.repertoire Package#

Client, models, and URL construction for Repertoire.

Classes#

ApiService(**data)

Base model for services with an API.

BaseRule(**data)

Base class for rules for deriving URLs.

BaseService(**data)

Base model for services.

DataService(**data)

A user-facing API service tied to a particular dataset.

DataServiceRule(**data)

Rule for a Phalanx service associated with a dataset.

Dataset(**data)

Discovery information about a single dataset.

DatasetConfig(**data)

Metadata for an available dataset.

Discovery(**data)

Service discovery information.

DiscoveryClient([http_client, base_url])

Client for Phalanx service and dataset discovery.

InfluxDatabase(**data)

Connection information for an InfluxDB database.

InfluxDatabaseConfig(**data)

Configuration for an InfluxDB database.

InfluxDatabaseWithCredentials(**data)

InfluxDB database connection information with credentials.

InternalService(**data)

An internal API service not tied to a particular dataset.

InternalServiceRule(**data)

Rule for an internal Phalanx service not associated with a dataset.

RepertoireBuilder(config)

Construct service discovery information from configuration.

RepertoireBuilderWithSecrets(config, ...)

Construct service discovery from configuration with secrets.

RepertoireError

Base class for Repertoire client exceptions.

RepertoireSettings([_case_sensitive, ...])

Base configuration from which Repertoire constructs URLs.

RepertoireUrlError

Base URL for Repertoire was not set.

RepertoireValidationError

Discovery information does not pass schema validation.

RepertoireWebError(message, *[, method, ...])

Exception arising from an HTTP request failure.

Services(**data)

Mappings of service names to service information.

UiService(**data)

A user interface service.

UiServiceRule(**data)

Rule for a UI Phalanx service accessed via a web browser.

Class Inheritance Diagram#

Inheritance diagram of rubin.repertoire._models.ApiService, rubin.repertoire._config.BaseRule, rubin.repertoire._models.BaseService, rubin.repertoire._models.DataService, rubin.repertoire._config.DataServiceRule, rubin.repertoire._models.Dataset, rubin.repertoire._config.DatasetConfig, rubin.repertoire._models.Discovery, rubin.repertoire._client.DiscoveryClient, rubin.repertoire._models.InfluxDatabase, rubin.repertoire._config.InfluxDatabaseConfig, rubin.repertoire._models.InfluxDatabaseWithCredentials, rubin.repertoire._models.InternalService, rubin.repertoire._config.InternalServiceRule, rubin.repertoire._builder.RepertoireBuilder, rubin.repertoire._builder.RepertoireBuilderWithSecrets, rubin.repertoire._exceptions.RepertoireError, rubin.repertoire._config.RepertoireSettings, rubin.repertoire._exceptions.RepertoireUrlError, rubin.repertoire._exceptions.RepertoireValidationError, rubin.repertoire._exceptions.RepertoireWebError, rubin.repertoire._models.Services, rubin.repertoire._models.UiService, rubin.repertoire._config.UiServiceRule