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:
1. sync: Blocking request that returns parsed data (if successful) or None
2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
3. asyncio: Like sync but async instead of blocking
4. asyncio_detailed: Like sync_detailed but 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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

octostar_python_client-0.1.775.tar.gz (161.8 kB view details)

Uploaded Jul 8, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

octostar_python_client-0.1.775-py3-none-any.whl (283.2 kB view details)

Uploaded Jul 8, 2026 Python 3

File details

Details for the file octostar_python_client-0.1.775.tar.gz.

File metadata

Download URL: octostar_python_client-0.1.775.tar.gz
Upload date: Jul 8, 2026
Size: 161.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for octostar_python_client-0.1.775.tar.gz
Algorithm	Hash digest
SHA256	`b942366bbb17098c99ec1a3283079f0f416aa69dfed2914e2a65f86af6a36fee`
MD5	`2492d9dd1a7022eb230b4f315781a373`
BLAKE2b-256	`6e3194c94fee129a9d9f45d28eb9e54c96751b7c55bb34a30073124e4e8ee876`

See more details on using hashes here.

Provenance

The following attestation bundles were made for octostar_python_client-0.1.775.tar.gz:

Publisher: main_branch.yml on Octostarco/octostar-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: octostar_python_client-0.1.775.tar.gz
- Subject digest: b942366bbb17098c99ec1a3283079f0f416aa69dfed2914e2a65f86af6a36fee
- Sigstore transparency entry: 2121343580
- Sigstore integration time: Jul 8, 2026
Source repository:
- Permalink: Octostarco/octostar-api@b3c4fc8fe02cb3ff3f7d54c408c8c7f1b1911db3
- Branch / Tag: refs/heads/main
- Owner: https://github.com/Octostarco
- Access: private
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: main_branch.yml@b3c4fc8fe02cb3ff3f7d54c408c8c7f1b1911db3
- Trigger Event: push