# 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
from yaci_client import AuthenticatedClient
client = AuthenticatedClient(
base_url="https://localhost:8080",
token="SuperSecretToken",
verify_ssl="/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_store_api_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", proxies="http://localhost:8030"))
```
## Building / publishing this package
This project uses [Poetry](https://python-poetry.org/) to manage dependencies and packaging. Here are the basics:
1. Update the metadata in pyproject.toml (e.g. authors, version)
1. If you're using a private repository, configure it with Poetry
1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
1. `poetry config http-basic.<your-repository-name> <username> <password>`
1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
If you want to install this client into another project without publishing it (e.g. for development) then:
1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
1. If that project is not using Poetry:
1. Build a wheel with `poetry build -f wheel`
1. Install that wheel from the other project `pip install <path-to-wheel>`
Raw data
{
"_id": null,
"home_page": "https://github.com/Kingpin-Apps/Yaci-client.git",
"name": "yaci_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Hareem Adderley",
"author_email": "haddderley@kingpinapps.com",
"download_url": null,
"platform": null,
"description": "# yaci-store-api-client\nA client library for accessing [Yaci](https://devkit.yaci.xyz) Store API.\n\nThis library is mostly generated using [OpenAPI Generator](https://github.com/openapi-generators/openapi-python-client/).\n\n## Usage\nFirst, create a client:\n\n```python\nfrom yaci_client import Client\n\nclient = Client(base_url=\"http://localhost:8080\", raise_on_unexpected_status=True)\n```\n\nIf the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:\n\n```python\nfrom yaci_client import AuthenticatedClient\n\nclient = AuthenticatedClient(base_url=\"https://localhost:8080\", token=\"SuperSecretToken\")\n```\n\nNow call your endpoint and use your models:\n\n```python\nimport json\nfrom yaci_client.api.local_epoch_service import (\n get_latest_protocol_params,\n)\nfrom yaci_client import Client\nfrom yaci_client.models import (\n ProtocolParamsDto,\n)\nfrom yaci_client.types import Response\n\nclient = Client(base_url=\"http://localhost:8080\", raise_on_unexpected_status=True)\n\nwith client as client:\n params: ProtocolParamsDto = get_latest_protocol_params.sync(client=client)\n print(params)\n \n response: Response[ProtocolParamsDto] = (\n get_latest_protocol_params.sync_detailed(client=client)\n )\n protocol_params_json = json.loads(response.content)\n print(protocol_params_json)\n```\n\nOr do the same thing with an async version:\n\n```python\nimport json\nfrom yaci_client.api.local_epoch_service import (\n get_latest_protocol_params,\n)\nfrom yaci_client import Client\nfrom yaci_client.models import (\n ProtocolParamsDto,\n)\nfrom yaci_client.types import Response\n\nclient = Client(base_url=\"http://localhost:8080\", raise_on_unexpected_status=True)\n\nasync with client as client:\n params: ProtocolParamsDto = await get_latest_protocol_params.asyncio(client=client)\n response: Response[ProtocolParamsDto] = await get_latest_protocol_params.asyncio_detailed(client=client)\n```\n\nBy 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.\n\n```python\nfrom yaci_client import AuthenticatedClient\n\nclient = AuthenticatedClient(\n base_url=\"https://localhost:8080\", \n token=\"SuperSecretToken\",\n verify_ssl=\"/path/to/certificate_bundle.pem\",\n)\n```\n\nYou can also disable certificate validation altogether, but beware that **this is a security risk**.\n\n```python\nfrom yaci_client import AuthenticatedClient\n\nclient = AuthenticatedClient(\n base_url=\"https://localhost:8080\", \n token=\"SuperSecretToken\", \n verify_ssl=False\n)\n```\n\nThings to know:\n1. Every path/method combo becomes a Python module with four functions:\n 1. `sync`: Blocking request that returns parsed data (if successful) or `None`\n 1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.\n 1. `asyncio`: Like `sync` but async instead of blocking\n 1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking\n\n1. All path/query params, and bodies become method arguments.\n1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)\n1. Any endpoint which did not have a tag will be in `yaci_store_api_client.api.default`\n\n## Advanced customizations\n\nThere 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):\n\n```python\nfrom yaci_client import Client\n\n\ndef log_request(request):\n print(f\"Request event hook: {request.method} {request.url} - Waiting for response\")\n\n\ndef log_response(response):\n request = response.request\n print(f\"Response event hook: {request.method} {request.url} - Status {response.status_code}\")\n\n\nclient = Client(\n base_url=\"https://api.example.com\",\n httpx_args={\"event_hooks\": {\"request\": [log_request], \"response\": [log_response]}},\n)\n\n# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()\n```\n\nYou can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):\n\n```python\nimport httpx\nfrom yaci_client import Client\n\nclient = Client(\n base_url=\"https://localhost:8080\",\n)\n# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.\nclient.set_httpx_client(httpx.Client(base_url=\"https://localhost:8080\", proxies=\"http://localhost:8030\"))\n```\n\n## Building / publishing this package\nThis project uses [Poetry](https://python-poetry.org/) to manage dependencies and packaging. Here are the basics:\n1. Update the metadata in pyproject.toml (e.g. authors, version)\n1. If you're using a private repository, configure it with Poetry\n 1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`\n 1. `poetry config http-basic.<your-repository-name> <username> <password>`\n1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`\n\nIf you want to install this client into another project without publishing it (e.g. for development) then:\n1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project\n1. If that project is not using Poetry:\n 1. Build a wheel with `poetry build -f wheel`\n 1. Install that wheel from the other project `pip install <path-to-wheel>`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A client library for accessing Yaci Store API",
"version": "1.0",
"project_urls": {
"Homepage": "https://github.com/Kingpin-Apps/Yaci-client.git",
"Repository": "https://github.com/Kingpin-Apps/Yaci-client.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "668d49a83f50d6a7088d7ccdc451f2b824ebb06a72cdd365338aaae268f122e1",
"md5": "c73fb6856fab741fe64b5774aa7b3769",
"sha256": "8715bfa87f6d9dbcc363e3167a3734c57a3660fbf8b1d1089cbc1745f909e45f"
},
"downloads": -1,
"filename": "yaci_client-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c73fb6856fab741fe64b5774aa7b3769",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 191874,
"upload_time": "2024-10-18T16:49:01",
"upload_time_iso_8601": "2024-10-18T16:49:01.479204Z",
"url": "https://files.pythonhosted.org/packages/66/8d/49a83f50d6a7088d7ccdc451f2b824ebb06a72cdd365338aaae268f122e1/yaci_client-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 16:49:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kingpin-Apps",
"github_project": "Yaci-client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "yaci_client"
}
JSON
