Skip to main content

Getting Started with OpenAPI spec for ClickHouse Cloud

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install ch-apimatic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/ch-apimatic-sdk/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
basic_auth_credentials BasicAuthCredentials The credential object for Basic Authentication

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from openapispecforclickhousecloud.configuration import Environment
from openapispecforclickhousecloud.http.auth.basic_auth import BasicAuthCredentials
from openapispecforclickhousecloud.logging.configuration.api_logging_configuration import LoggingConfiguration
from openapispecforclickhousecloud.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from openapispecforclickhousecloud.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from openapispecforclickhousecloud.openapispecforclickhousecloud_client import OpenapispecforclickhousecloudClient

client = OpenapispecforclickhousecloudClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='BasicAuthUserName',
        password='BasicAuthPassword'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from openapispecforclickhousecloud.openapispecforclickhousecloud_client import OpenapispecforclickhousecloudClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = OpenapispecforclickhousecloudClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for ch-apimatic-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ch-apimatic-sdk 0.0.1
File Size Uploaded Provenance Actions
ch_apimatic_sdk-0.0.1.tar.gz 362.6 kB Without provenance Details for ch_apimatic_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ch-apimatic-sdk 0.0.1
File Interpreter ABI Platform Actions
ch_apimatic_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for ch_apimatic_sdk-0.0.1-py3-none-any.whl

Total release size: 1.6 MB

Release files / ch_apimatic_sdk-0.0.1.tar.gz

Download URL ch_apimatic_sdk-0.0.1.tar.gz
Size 362.6 kB
Tags Source
SHA-256 checksum
How to use checksums
daf9a7aa30bfb82c56023107b3f7404aca6e5981b512cc635de4ec71d29bed1a
BLAKE2b-256 checksum
How to use checksums
49e70cff499b6259933b7f3aae8f68701bdfecb06d4947c92f4e278870d1bbe6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.15 Linux/6.1.158.2-microsoft-standard

Release files / ch_apimatic_sdk-0.0.1-py3-none-any.whl

Download URL ch_apimatic_sdk-0.0.1-py3-none-any.whl
Size 1.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
ebef85ffc2802b1a4dfb55062c9adb9fcebf86fd0182a6c8bda5b5dbf3016708
BLAKE2b-256 checksum
How to use checksums
9824e585455daa0bfe4f575941f6a7e8aa2d297c1c009dee7274c80fdb9c0be0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.15 Linux/6.1.158.2-microsoft-standard

Security for ch-apimatic-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page