octostar-python-client
A client library for accessing Octostar API
Usage
First, create a client:
from octostar import Client
client = Client(base_url="https://api.example.com")
If the endpoints you're going to hit require authentication, use AuthenticatedClient instead:
from octostar import AuthenticatedClient
client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
Now call your endpoint and use your models:
from octostar.models import MyDataModel
from octostar.api.my_tag import get_my_data_model
from octostar.types import Response
my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
Or do the same thing with an async version:
from octostar.models import MyDataModel
from octostar.api.my_tag import get_my_data_model
from octostar.types import Response
my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.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.
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl="/path/to/certificate_bundle.pem",
)
You can also disable certificate validation altogether, but beware that this is a security risk.
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl=False
)
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.
Things to know:
-
Every path/method combo becomes a Python module with four functions:
sync: Blocking request that returns parsed data (if successful) orNonesync_detailed: Blocking request that always returns aRequest, optionally withparsedset if the request was successful.asyncio: Likesyncbut async instead of blockingasyncio_detailed: Likesync_detailedbut async instead of blocking
-
All path/query params, and bodies become method arguments.
-
If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-
Any endpoint which did not have a tag will be in
octostar.api.default
Installing
pip install octostar-python-client
Testing a PR build (TestPyPI)
Every pull request that touches the SDK publishes a pre-release to
TestPyPI versioned
0.0.<pr>.dev<run_number> (e.g. 0.0.898.dev1319) — the <pr> segment is the
PR number, so you can find the build for your PR. Use it to test SDK changes
before they merge.
TestPyPI does not host third-party dependencies (httpx, tenacity, …), so
point the resolver at PyPI as an extra index for them:
# pip
pip install \
--index-url https://test.pypi.org/simple/ \
--extra-index-url https://pypi.org/simple/ \
octostar-python-client==0.0.<pr>.dev<N>
# uv (--index-strategy so uv considers both indexes per-package)
uv pip install \
--index-url https://test.pypi.org/simple/ \
--extra-index-url https://pypi.org/simple/ \
--index-strategy unsafe-best-match \
octostar-python-client==0.0.<pr>.dev<N>
Releasing
Releases are automated. On every merge to main, the octostar-api release
pipeline builds this package and publishes it to PyPI, stamped with the
octostar-api version. There is no manual publish step.
To build the package locally for development:
./scripts/sdk/build.sh # writes octostar_python_client/dist/*.whl and *.tar.gz
pip install octostar_python_client/dist/*.whl
1 maintainer
Release files for octostar-python-client 0.1.947
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| octostar_python_client-0.1.947.tar.gz | 162.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| octostar_python_client-0.1.947-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 445.8 kB
Release files / octostar_python_client-0.1.947.tar.gz
| Download URL | octostar_python_client-0.1.947.tar.gz |
|---|---|
| Size | 162.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fe8fe4703210b2e528c89b7e0eddc367816b45f5139b7a3f8131905e48d6f4e8
|
|
BLAKE2b-256 checksum How to use checksums |
5553bda1390ec44c59a6b4527d65f816fed7b8feaf2385f4a7c4e328c5668cbd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency logRelease files / octostar_python_client-0.1.947-py3-none-any.whl
| Download URL | octostar_python_client-0.1.947-py3-none-any.whl |
|---|---|
| Size | 283.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
932cb640901165fc3a2bf9842b555552da0d7c247630bc753a86c93346312153
|
|
BLAKE2b-256 checksum How to use checksums |
df4d18cbb5a4fe3a629fa29fe88524fdd3db17149078f5e9c7dc2802657f7e68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency log
