voltaria-sdk 2.34.5__tar.gz

voltaria_sdk-2.34.5/.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v8.2.0
+      - run: uv build
+      - run: uv publish

voltaria_sdk-2.34.5/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: voltaria-sdk
+Version: 2.34.5
+Summary: Official Python SDK for the Voltaria API
+Project-URL: Repository, https://github.com/voltariafinance/python-sdk
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.21
+Requires-Dist: pydantic>=1.9
+Requires-Dist: typing-extensions>=4.0

voltaria_sdk-2.34.5/README.md

@@ -0,0 +1,223 @@
+<!-- voltaria-readme-assembled -->
+# Voltaria Python Library
+
+## Quickstart
+
+Install from PyPI (published as `voltaria-sdk`, imported as `voltaria`):
+
+```bash
+pip install voltaria-sdk
+```
+
+Construct the client with just your API key — the environment is derived from the
+key prefix, so you don't configure a base URL:
+
+```python
+from voltaria import Voltaria
+
+client = Voltaria("live_...")        # production
+# client = Voltaria("sandbox_...")   # sandbox
+
+loans = client.loans.list_loans()
+```
+
+| Key prefix | Environment | Base URL                          |
+| ---------- | ----------- | --------------------------------- |
+| `live_`    | Production  | `https://api.voltaria.io`         |
+| `sandbox_` | Sandbox     | `https://api.sandbox.voltaria.io` |
+
+Pass `base_url=` or `environment=` to override routing. An async client
+(`AsyncVoltaria`) is also available with the same interface.
+
+See [reference.md](./reference.md) for the full API reference.
+
+---
+
+[![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=Voltaria%2FPython)
+[![pypi](https://img.shields.io/pypi/v/voltaria_sdk)](https://pypi.python.org/pypi/voltaria_sdk)
+
+The Voltaria Python library provides convenient access to the Voltaria APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [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 voltaria_sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from voltaria import Voltaria
+
+client = Voltaria(
+    token="<token>",
+)
+
+client.clients.create_client(
+    name="ACME Corp",
+    jurisdiction="eu",
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from voltaria import Voltaria
+from voltaria_sdk.environment import VoltariaEnvironment
+
+client = Voltaria(
+    environment=VoltariaEnvironment.SANDBOX,
+)
+```
+
+## 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 voltaria import AsyncVoltaria
+
+client = AsyncVoltaria(
+    token="<token>",
+)
+
+
+async def main() -> None:
+    await client.clients.create_client(
+        name="ACME Corp",
+        jurisdiction="eu",
+    )
+
+
+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 voltaria_sdk.core.api_error import ApiError
+
+try:
+    client.clients.create_client(...)
+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 voltaria import Voltaria
+
+client = Voltaria(...)
+response = client.clients.with_raw_response.create_client(...)
+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.clients.create_client(..., 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 voltaria import Voltaria
+
+client = Voltaria(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.clients.create_client(..., 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 voltaria import Voltaria
+
+client = Voltaria(
+    ...,
+    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!

voltaria_sdk-2.34.5/pyproject.toml

@@ -0,0 +1,25 @@
+# Hand-written packaging manifest (Fern does not generate one). Listed in
+# .fernignore so regeneration never clobbers it. `version` is stamped by the
+# API repo's deployment pipeline at release time.
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "voltaria-sdk"
+version = "2.34.5"
+description = "Official Python SDK for the Voltaria API"
+requires-python = ">=3.9"
+dependencies = [
+    "httpx>=0.21",
+    "pydantic>=1.9",
+    "typing_extensions>=4.0",
+]
+
+[project.urls]
+Repository = "https://github.com/voltariafinance/python-sdk"
+
+[tool.hatch.build.targets.wheel]
+# Ship the whole `voltaria` package — hand-written entry/wrapper plus the
+# generated code under voltaria/_generated/.
+packages = ["voltaria"]