config

Quantinuum Nexus API client configuration via pydantic-settings.

class qnexus.config.Config(
_case_sensitive: bool | None = None,
_nested_model_default_partial_update: bool | None = None,
_env_prefix: str | None = None,
_env_file: DotenvType | None = PosixPath('.'),
_env_file_encoding: str | None = None,
_env_ignore_empty: bool | None = None,
_env_nested_delimiter: str | None = None,
_env_nested_max_split: int | None = None,
_env_parse_none_str: str | None = None,
_env_parse_enums: bool | None = None,
_cli_prog_name: str | None = None,
_cli_parse_args: bool | list[str] | tuple[str, ...] | None = None,
_cli_settings_source: CliSettingsSource[Any] | None = None,
_cli_parse_none_str: str | None = None,
_cli_hide_none_type: bool | None = None,
_cli_avoid_json: bool | None = None,
_cli_enforce_required: bool | None = None,
_cli_use_class_docs_for_groups: bool | None = None,
_cli_exit_on_error: bool | None = None,
_cli_prefix: str | None = None,
_cli_flag_prefix_char: str | None = None,
_cli_implicit_flags: bool | None = None,
_cli_ignore_unknown_args: bool | None = None,
_cli_kebab_case: bool | None = None,
_cli_shortcuts: Mapping[str, str | list[str]] | None = None,
_secrets_dir: PathType | None = None,
*,
protocol: str = 'https',
websockets_protocol: str = 'wss',
domain: str = 'nexus.quantinuum.com',
port: int = 443,
httpx_verify: bool = True,
store_tokens: bool = True,
token_path: str = '.qnx/auth',
qa_user_email: str = '',
qa_user_password: str = '',
)[source]

QNexus Configuration schema.

Uses pydantic-settings to read environment variables for qnexus configuration.

domain: str
httpx_verify: bool
port: int
protocol: str
qa_user_email: str
qa_user_password: str
store_tokens: bool
token_path: str
property url: str

Current http API URL

websockets_protocol: str
property websockets_url: str

Current websockets API URL