Settings

pydantic settings algoseek_connector.settings.AlgoseekConnectorSettings

Bases: BaseSettings

Store library configuration.

Setting fields may be set through environment variables by using the notation

ALGOSEEK__{SETTINGS_GROUP}__{SETTINGS_FIELD}

where SETTINGS_GROUP may be ARDADB, DATASET_API or S3. Refer to each submodel for the corresponding setting fields available.

field ardadb: models.ArdaDBConfiguration = ArdaDBConfiguration(host='0.0.0.0', port=8123, user=SecretStr(''), password=SecretStr(''), extra={})

ArdaDB settings

field dataset_api: models.DatasetAPIConfiguration = DatasetAPIConfiguration(url='https://datasets-metadata.algoseek.com/api/v2', headers=None, email=SecretStr('**********'), password=SecretStr('**********'))

Dataset API settings

field s3: models.S3Configuration = S3Configuration(aws_access_key_id=None, aws_secret_access_key=None, profile_name=None, region_name='us-east-1', download_limit=1099511627776, download_limit_do_not_change=21990232555520)

S3 data source settings.

pydantic model algoseek_connector.models.ArdaDBConfiguration

Bases: BaseConfigModel

Store ArdaDB data source configuration.

field extra: dict = {}

Optional arguments passed to clickhouse_connect.get_client. See here for a description of the parameters that are accepted.

field host: str = '0.0.0.0'

The ArdaDB host Address

field password: pydantic.SecretStr = SecretStr('')

The ArdaDB password

field port: pydantic.PositiveInt = 8123

The ArdaDB connection port

field user: pydantic.SecretStr = SecretStr('')

The ArdaDB user name

pydantic model algoseek_connector.models.S3Configuration

Bases: BaseConfigModel

Store S3 data source configuration.

field aws_access_key_id: str | None = None

The AWS access key id. If provided, overwrite profile credentials.

field aws_secret_access_key: pydantic.SecretStr | None = None

The AWS secret access key. If provided, overwrite profile credentials.

field download_limit: pydantic.PositiveInt = 1099511627776

S3 datasets download quota, in bytes. Set by default to 1 TiB.

field download_limit_do_not_change: pydantic.PositiveInt = 21990232555520

A second download limit fo S3 datasets, in bytes. Set by default to 20 TiB.

field profile_name: str | None = None

A profile stored in ~/.aws/credentials

field region_name: str = 'us-east-1'

Default region when creating new connections

pydantic model algoseek_connector.models.DatasetAPIConfiguration

Bases: BaseConfigModel

Store dataset API configuration.

field email: pydantic.SecretStr | None = None

the email to request an access token.

field headers: dict[str, str] | None = None

Headers to include in all requests.

field password: pydantic.SecretStr | None = None

the password to request an access token.

field url: str = 'https://datasets-metadata.algoseek.com/api/v2'

The API base URL