yaci-client 1.0.1__tar.gz

yaci_client-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Hareem Adderley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yaci_client-1.0.1/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: yaci-client
+Version: 1.0.1
+Summary: A client library for accessing the Yaci Store API
+Keywords: cardano,yaci,yaci-store,yaci-devkit,openapi
+Author: Hareem Adderley
+Author-email: Hareem Adderley <hadderley@kingpinapps.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx>=0.25.1,<0.29.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/Kingpin-Apps/Yaci-client
+Project-URL: Source, https://github.com/Kingpin-Apps/Yaci-client
+Project-URL: Issues, https://github.com/Kingpin-Apps/Yaci-client/issues
+Project-URL: Changelog, https://github.com/Kingpin-Apps/Yaci-client/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# yaci-store-api-client
+A client library for accessing [Yaci](https://devkit.yaci.xyz) Store API.
+
+This library is  mostly generated using [OpenAPI Generator](https://github.com/openapi-generators/openapi-python-client/).
+
+## Usage
+First, create a client:
+
+```python
+from yaci_client import Client
+
+client = Client(base_url="http://localhost:8080", raise_on_unexpected_status=True)
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from yaci_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://localhost:8080", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+import json
+from yaci_client.api.local_epoch_service import (
+    get_latest_protocol_params,
+)
+from yaci_client import Client
+from yaci_client.models import (
+    ProtocolParamsDto,
+)
+from yaci_client.types import Response
+
+client = Client(base_url="http://localhost:8080", raise_on_unexpected_status=True)
+
+with client as client:
+    params: ProtocolParamsDto = get_latest_protocol_params.sync(client=client)
+    print(params)
+
+    response: Response[ProtocolParamsDto] = get_latest_protocol_params.sync_detailed(client=client)
+    protocol_params_json = json.loads(response.content)
+    print(protocol_params_json)
+```
+
+Or do the same thing with an async version:
+
+```python
+import json
+from yaci_client.api.local_epoch_service import (
+    get_latest_protocol_params,
+)
+from yaci_client import Client
+from yaci_client.models import (
+    ProtocolParamsDto,
+)
+from yaci_client.types import Response
+
+client = Client(base_url="http://localhost:8080", raise_on_unexpected_status=True)
+
+async with client as client:
+    params: ProtocolParamsDto = await get_latest_protocol_params.asyncio(client=client)
+    response: Response[ProtocolParamsDto] = await get_latest_protocol_params.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+import ssl
+
+from yaci_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://localhost:8080",
+    token="SuperSecretToken",
+    verify_ssl=ssl.create_default_context(cafile="/path/to/certificate_bundle.pem"),
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+from yaci_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://localhost:8080", token="SuperSecretToken", verify_ssl=False)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `yaci_client.api.default`
+
+## Advanced customizations
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from yaci_client import Client
+
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+
+client = Client(
+    base_url="https://api.example.com",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from yaci_client import Client
+
+client = Client(
+    base_url="https://localhost:8080",
+)
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://localhost:8080", proxy="http://localhost:8030"))
+```
+
+## Installation
+
+```bash
+pip install yaci-client
+```
+
+It needs Python 3.11 or newer and works with httpx 0.25.1 up to 0.28.
+
+## Development
+
+The project uses [uv](https://docs.astral.sh/uv/), [ruff](https://docs.astral.sh/ruff/),
+[ty](https://docs.astral.sh/ty/) and [just](https://just.systems/). Run `just` to list every task.
+
+```bash
+just sync       # install the project and its development tools
+just check      # lint, type-check and test
+just test-all   # the tests on every supported Python
+```
+
+`yaci_client` is generated from the Yaci Store OpenAPI spec in `yaci_api.json` by
+[openapi-python-client](https://github.com/openapi-generators/openapi-python-client). After
+updating the spec, run `just regenerate`; ruff then formats the result, so it passes `just lint`.
+Review the diff before committing: newer generators rename fields (for example `type` to `type_`), which
+breaks callers, so a rename belongs in a major release.
+
+Commits follow [Conventional Commits](https://www.conventionalcommits.org/). Run
+`uv run pre-commit install` once to check messages and formatting on each commit.
+
+## Releasing
+
+1. `just bump` sets the version and the changelog from the commits since the last release, and tags it `vX.Y.Z`.
+1. Push the commit and the tag: `git push --follow-tags`.
+1. The tag starts the [Release workflow](.github/workflows/release.yml), which builds the package, publishes it
+   to [PyPI](https://pypi.org/project/yaci-client/) with Trusted Publishing (no token in the repository) and
+   creates the GitHub release.

yaci_client-1.0.1/README.md

@@ -0,0 +1,172 @@
+# yaci-store-api-client
+A client library for accessing [Yaci](https://devkit.yaci.xyz) Store API.
+
+This library is  mostly generated using [OpenAPI Generator](https://github.com/openapi-generators/openapi-python-client/).
+
+## Usage
+First, create a client:
+
+```python
+from yaci_client import Client
+
+client = Client(base_url="http://localhost:8080", raise_on_unexpected_status=True)
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from yaci_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://localhost:8080", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+import json
+from yaci_client.api.local_epoch_service import (
+    get_latest_protocol_params,
+)
+from yaci_client import Client
+from yaci_client.models import (
+    ProtocolParamsDto,
+)
+from yaci_client.types import Response
+
+client = Client(base_url="http://localhost:8080", raise_on_unexpected_status=True)
+
+with client as client:
+    params: ProtocolParamsDto = get_latest_protocol_params.sync(client=client)
+    print(params)
+
+    response: Response[ProtocolParamsDto] = get_latest_protocol_params.sync_detailed(client=client)
+    protocol_params_json = json.loads(response.content)
+    print(protocol_params_json)
+```
+
+Or do the same thing with an async version:
+
+```python
+import json
+from yaci_client.api.local_epoch_service import (
+    get_latest_protocol_params,
+)
+from yaci_client import Client
+from yaci_client.models import (
+    ProtocolParamsDto,
+)
+from yaci_client.types import Response
+
+client = Client(base_url="http://localhost:8080", raise_on_unexpected_status=True)
+
+async with client as client:
+    params: ProtocolParamsDto = await get_latest_protocol_params.asyncio(client=client)
+    response: Response[ProtocolParamsDto] = await get_latest_protocol_params.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+import ssl
+
+from yaci_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://localhost:8080",
+    token="SuperSecretToken",
+    verify_ssl=ssl.create_default_context(cafile="/path/to/certificate_bundle.pem"),
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+from yaci_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://localhost:8080", token="SuperSecretToken", verify_ssl=False)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `yaci_client.api.default`
+
+## Advanced customizations
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from yaci_client import Client
+
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+
+client = Client(
+    base_url="https://api.example.com",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from yaci_client import Client
+
+client = Client(
+    base_url="https://localhost:8080",
+)
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://localhost:8080", proxy="http://localhost:8030"))
+```
+
+## Installation
+
+```bash
+pip install yaci-client
+```
+
+It needs Python 3.11 or newer and works with httpx 0.25.1 up to 0.28.
+
+## Development
+
+The project uses [uv](https://docs.astral.sh/uv/), [ruff](https://docs.astral.sh/ruff/),
+[ty](https://docs.astral.sh/ty/) and [just](https://just.systems/). Run `just` to list every task.
+
+```bash
+just sync       # install the project and its development tools
+just check      # lint, type-check and test
+just test-all   # the tests on every supported Python
+```
+
+`yaci_client` is generated from the Yaci Store OpenAPI spec in `yaci_api.json` by
+[openapi-python-client](https://github.com/openapi-generators/openapi-python-client). After
+updating the spec, run `just regenerate`; ruff then formats the result, so it passes `just lint`.
+Review the diff before committing: newer generators rename fields (for example `type` to `type_`), which
+breaks callers, so a rename belongs in a major release.
+
+Commits follow [Conventional Commits](https://www.conventionalcommits.org/). Run
+`uv run pre-commit install` once to check messages and formatting on each commit.
+
+## Releasing
+
+1. `just bump` sets the version and the changelog from the commits since the last release, and tags it `vX.Y.Z`.
+1. Push the commit and the tag: `git push --follow-tags`.
+1. The tag starts the [Release workflow](.github/workflows/release.yml), which builds the package, publishes it
+   to [PyPI](https://pypi.org/project/yaci-client/) with Trusted Publishing (no token in the repository) and
+   creates the GitHub release.

yaci_client-1.0.1/pyproject.toml

@@ -0,0 +1,135 @@
+[project]
+name = "yaci-client"
+version = "1.0.1"
+description = "A client library for accessing the Yaci Store API"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+keywords = [
+    "cardano",
+    "yaci",
+    "yaci-store",
+    "yaci-devkit",
+    "openapi",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Typing :: Typed",
+]
+dependencies = [
+    "attrs>=22.2.0",
+    "httpx>=0.25.1,<0.29.0",
+    "python-dateutil>=2.8.0",
+]
+
+[[project.authors]]
+name = "Hareem Adderley"
+email = "hadderley@kingpinapps.com"
+
+[project.urls]
+Homepage = "https://github.com/Kingpin-Apps/Yaci-client"
+Source = "https://github.com/Kingpin-Apps/Yaci-client"
+Issues = "https://github.com/Kingpin-Apps/Yaci-client/issues"
+Changelog = "https://github.com/Kingpin-Apps/Yaci-client/blob/main/CHANGELOG.md"
+
+[dependency-groups]
+dev = [
+    { include-group = "lint" },
+    { include-group = "test" },
+    "commitizen>=4.8",
+    "pre-commit>=4.3",
+]
+lint = [
+    "ruff>=0.17",
+    "ty>=0.0.90",
+]
+test = [
+    "pytest>=8.4",
+    "pytest-asyncio>=1.2",
+    "pytest-cov>=7",
+]
+generate = ["openapi-python-client>=0.27.1,<0.28"]
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.uv.build-backend]
+module-root = ""
+
+[tool.pytest.ini_options]
+minversion = "8.0"
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+addopts = [
+    "-ra",
+    "--strict-markers",
+]
+filterwarnings = ["error"]
+
+[tool.coverage.run]
+source = ["yaci_client"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+extend-exclude = ["dist"]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "W",
+    "F",
+    "I",
+    "B",
+    "UP",
+    "SIM",
+    "RUF",
+    "ASYNC",
+    "PT",
+]
+ignore = [
+    "E501",
+    "UP042",
+    "SIM108",
+]
+
+[tool.ty.environment]
+python-version = "3.11"
+
+[tool.ty.src]
+include = [
+    "yaci_client",
+    "tests",
+    "example.py",
+]
+
+[tool.ty.terminal]
+error-on-warning = true
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+version_provider = "uv"
+tag_format = "v$version"
+update_changelog_on_bump = true
+major_version_zero = false
+version_files = ["yaci_client/__init__.py:__version__"]

yaci_client-1.0.1/pyproject.toml.orig

@@ -0,0 +1,113 @@
+[project]
+name = "yaci-client"
+version = "1.0.1"
+description = "A client library for accessing the Yaci Store API"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Hareem Adderley", email = "hadderley@kingpinapps.com" }]
+requires-python = ">=3.11"
+keywords = ["cardano", "yaci", "yaci-store", "yaci-devkit", "openapi"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Typing :: Typed",
+]
+dependencies = [
+    # 22.2 adds the `alias` argument the generated client passes to attrs.field().
+    "attrs>=22.2.0",
+    # 0.25.1 is the first release on httpcore 1.x without `import cgi`: older ones fail on Python 3.13+.
+    "httpx>=0.25.1,<0.29.0",
+    "python-dateutil>=2.8.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Kingpin-Apps/Yaci-client"
+Source = "https://github.com/Kingpin-Apps/Yaci-client"
+Issues = "https://github.com/Kingpin-Apps/Yaci-client/issues"
+Changelog = "https://github.com/Kingpin-Apps/Yaci-client/blob/main/CHANGELOG.md"
+
+[dependency-groups]
+dev = [
+    { include-group = "lint" },
+    { include-group = "test" },
+    "commitizen>=4.8",
+    "pre-commit>=4.3",
+]
+lint = [
+    "ruff>=0.17",
+    "ty>=0.0.90",
+]
+test = [
+    "pytest>=8.4",
+    "pytest-asyncio>=1.2",
+    "pytest-cov>=7",
+]
+generate = [
+    # 0.28 drops the `Unset` import from submit_tx_1, so stay on 0.27 until that is fixed upstream.
+    "openapi-python-client>=0.27.1,<0.28",
+]
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.uv.build-backend]
+# The package sits at the repository root rather than under src/.
+module-root = ""
+
+[tool.pytest.ini_options]
+minversion = "8.0"
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+addopts = ["-ra", "--strict-markers"]
+# Every warning fails the test that raised it: deprecations are caught early.
+filterwarnings = ["error"]
+
+[tool.coverage.run]
+source = ["yaci_client"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+extend-exclude = ["dist"]
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "UP", "SIM", "RUF", "ASYNC", "PT"]
+# E501: generated docstrings carry long descriptions from the OpenAPI spec.
+# UP042, SIM108: the generator's own style for enums and response parsing.
+ignore = ["E501", "UP042", "SIM108"]
+
+[tool.ty.environment]
+python-version = "3.11"
+
+[tool.ty.src]
+include = ["yaci_client", "tests", "example.py"]
+
+[tool.ty.terminal]
+error-on-warning = true
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+version_provider = "uv"
+tag_format = "v$version"
+update_changelog_on_bump = true
+major_version_zero = false
+version_files = ["yaci_client/__init__.py:__version__"]

yaci_client-1.0.1/yaci_client/__init__.py

@@ -0,0 +1,10 @@
+"""A client library for accessing Yaci Store API"""
+
+from .client import AuthenticatedClient, Client
+
+__version__ = "1.0.1"
+__app_name__ = "yaci_client"
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

yaci_client-1.0.1/yaci_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""