contextbase-base-client 0.5.0__py3-none-any.whl

base_client/.fern/metadata.json

@@ -0,0 +1,13 @@
+{
+  "cliVersion": "5.50.3",
+  "generatorName": "fernapi/fern-python-sdk",
+  "generatorVersion": "5.14.20",
+  "generatorConfig": {
+    "package_name": "base_client",
+    "client_class_name": "BaseAPIClient"
+  },
+  "originGitCommit": "23e427b68efec26440c8b4b9c5b5b89cd90fa7ce",
+  "originGitCommitIsDirty": true,
+  "invokedBy": "ci",
+  "ciProvider": "github"
+}

base_client/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.9+
+- pip
+- poetry
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+poetry install
+```
+
+### Building
+
+Build the project:
+
+```bash
+poetry build
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+poetry run pytest
+```
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+poetry run ruff check .
+poetry run ruff format .
+```
+
+### Type Checking
+
+Run the type checker:
+
+```bash
+poetry run mypy .
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `src/` - API client classes and types
+- Most Python files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Python SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/python-v2/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `poetry run pytest`
+4. Run linting and formatting: `poetry run ruff check .` and `poetry run ruff format .`
+5. Run type checking: `poetry run mypy .`
+6. Build the project: `poetry build`
+7. Commit your changes with a clear commit message
+8. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses automated code formatting and linting. Run `poetry run ruff format .` and `poetry run ruff check .` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

base_client/README.md

@@ -0,0 +1,176 @@
+# Contextlayer Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Contextlayer%2FPython)
+[![pypi](https://img.shields.io/pypi/v/base_client)](https://pypi.python.org/pypi/base_client)
+
+The Contextlayer Python library provides convenient access to the Contextlayer APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install base_client
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from base_client import BaseAPIClient
+
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+
+client.bases.create_base(
+    dsn_secret="dsn_secret",
+    name="name",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from base_client import AsyncBaseAPIClient
+
+client = AsyncBaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+
+
+async def main() -> None:
+    await client.bases.create_base(
+        dsn_secret="dsn_secret",
+        name="name",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from base_client.core.api_error import ApiError
+
+try:
+    client.bases.create_base(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from base_client import BaseAPIClient
+
+client = BaseAPIClient(...)
+response = client.bases.with_raw_response.create_base(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (All server errors, including 500)
+
+**`recommended`**: retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.bases.create_base(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+from base_client import BaseAPIClient
+
+client = BaseAPIClient(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.bases.create_base(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from base_client import BaseAPIClient
+
+client = BaseAPIClient(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

base_client/__init__.py

@@ -0,0 +1,159 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        ApiKeyAuth,
+        AuthenticatedAccountRef,
+        Base,
+        Binding,
+        BindingAuth,
+        BindingAuthInput,
+        BindingAuthInputApiKey,
+        BindingAuthInputAuthenticatedAccount,
+        BindingAuthInputClientCredentials,
+        BindingAuthInputNone,
+        BindingAuthInput_ApiKey,
+        BindingAuthInput_AuthenticatedAccount,
+        BindingAuthInput_ClientCredentials,
+        BindingAuthInput_None,
+        BindingAuthNone,
+        BindingAuth_ApiKey,
+        BindingAuth_AuthenticatedAccount,
+        BindingAuth_ClientCredentials,
+        BindingAuth_None,
+        BindingModels,
+        BindingState,
+        BindingStateResponse,
+        ClientCredentialsAuth,
+        DagsterAllPlanBinding,
+        DagsterAllPlanBindingMode,
+        DagsterBindingPlanAll,
+        DsnResponse,
+        Error,
+        RunStatus,
+    )
+    from .errors import BadRequestError, ForbiddenError
+    from . import bases, binding_plan, bindings, dsn, sync_state
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .bases import ListBasesResponse
+    from .bindings import ListBindingsResponse
+    from .client import AsyncBaseAPIClient, BaseAPIClient
+    from .sync_state import SyncStateInputBindingsValue
+_dynamic_imports: typing.Dict[str, str] = {
+    "ApiKeyAuth": ".types",
+    "AsyncBaseAPIClient": ".client",
+    "AuthenticatedAccountRef": ".types",
+    "BadRequestError": ".errors",
+    "Base": ".types",
+    "BaseAPIClient": ".client",
+    "Binding": ".types",
+    "BindingAuth": ".types",
+    "BindingAuthInput": ".types",
+    "BindingAuthInputApiKey": ".types",
+    "BindingAuthInputAuthenticatedAccount": ".types",
+    "BindingAuthInputClientCredentials": ".types",
+    "BindingAuthInputNone": ".types",
+    "BindingAuthInput_ApiKey": ".types",
+    "BindingAuthInput_AuthenticatedAccount": ".types",
+    "BindingAuthInput_ClientCredentials": ".types",
+    "BindingAuthInput_None": ".types",
+    "BindingAuthNone": ".types",
+    "BindingAuth_ApiKey": ".types",
+    "BindingAuth_AuthenticatedAccount": ".types",
+    "BindingAuth_ClientCredentials": ".types",
+    "BindingAuth_None": ".types",
+    "BindingModels": ".types",
+    "BindingState": ".types",
+    "BindingStateResponse": ".types",
+    "ClientCredentialsAuth": ".types",
+    "DagsterAllPlanBinding": ".types",
+    "DagsterAllPlanBindingMode": ".types",
+    "DagsterBindingPlanAll": ".types",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DsnResponse": ".types",
+    "Error": ".types",
+    "ForbiddenError": ".errors",
+    "ListBasesResponse": ".bases",
+    "ListBindingsResponse": ".bindings",
+    "RunStatus": ".types",
+    "SyncStateInputBindingsValue": ".sync_state",
+    "bases": ".bases",
+    "binding_plan": ".binding_plan",
+    "bindings": ".bindings",
+    "dsn": ".dsn",
+    "sync_state": ".sync_state",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "ApiKeyAuth",
+    "AsyncBaseAPIClient",
+    "AuthenticatedAccountRef",
+    "BadRequestError",
+    "Base",
+    "BaseAPIClient",
+    "Binding",
+    "BindingAuth",
+    "BindingAuthInput",
+    "BindingAuthInputApiKey",
+    "BindingAuthInputAuthenticatedAccount",
+    "BindingAuthInputClientCredentials",
+    "BindingAuthInputNone",
+    "BindingAuthInput_ApiKey",
+    "BindingAuthInput_AuthenticatedAccount",
+    "BindingAuthInput_ClientCredentials",
+    "BindingAuthInput_None",
+    "BindingAuthNone",
+    "BindingAuth_ApiKey",
+    "BindingAuth_AuthenticatedAccount",
+    "BindingAuth_ClientCredentials",
+    "BindingAuth_None",
+    "BindingModels",
+    "BindingState",
+    "BindingStateResponse",
+    "ClientCredentialsAuth",
+    "DagsterAllPlanBinding",
+    "DagsterAllPlanBindingMode",
+    "DagsterBindingPlanAll",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DsnResponse",
+    "Error",
+    "ForbiddenError",
+    "ListBasesResponse",
+    "ListBindingsResponse",
+    "RunStatus",
+    "SyncStateInputBindingsValue",
+    "bases",
+    "binding_plan",
+    "bindings",
+    "dsn",
+    "sync_state",
+]

base_client/_default_clients.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError("To use the aiohttp client, install the aiohttp extra: pip install base_client[aiohttp]")
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)

base_client/bases/__init__.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import ListBasesResponse
+_dynamic_imports: typing.Dict[str, str] = {"ListBasesResponse": ".types"}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["ListBasesResponse"]