Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/sdk-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Python SDK CI

on:
push:
pull_request:

jobs:
verify:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: "3.11"
- run: python -m pip install --upgrade build
- run: python -m build
28 changes: 28 additions & 0 deletions .github/workflows/sdk-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Python SDK Release

on:
release:
types: [published]
workflow_dispatch:

permissions:
contents: read
id-token: write
packages: write

jobs:
release:
runs-on: ubuntu-latest
env:
VERSIONING_POLICY: manual
steps:
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: "3.11"
- run: python -m pip install --upgrade build
- run: python -m build
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
with:
skip-existing: true
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Generated by Scalar SDK Generator.
__pycache__/
*.py[cod]
*.egg-info/
.venv/
dist/
build/
.mypy_cache/
.pytest_cache/
.ruff_cache/
5 changes: 5 additions & 0 deletions .scalar/sdk-sync.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"build": "upKs3uV5D38PUtXzXTiWZ",
"slug": "demo-api-scalar-galaxy-python",
"version": "0.1.1"
}
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## v0.1.1 (2026-06-25)

Initial release.
3 changes: 3 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-License-Identifier: MIT

See the project repository for the full license text.
232 changes: 231 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,231 @@
# galaxy-python-sdk
# Scalar Galaxy

Generated Python SDK for Scalar Galaxy API.
The Scalar Galaxy is an example OpenAPI document to test OpenAPI tools and libraries. It's a fictional universe with fictional planets and fictional data. Get all the data for [all planets](#tag/planets/get/planets).

## Resources

* https://github.com/scalar/scalar
* https://github.com/OAI/OpenAPI-Specification
* https://scalar.com

## Markdown Support

All descriptions *can* contain ~~tons of text~~ **Markdown**. [If GitHub supports the syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax), chances are we're supporting it, too. You can even create [internal links to reference endpoints](#tag/authentication/post/user/signup).

<details>
<summary>Examples</summary>

**Blockquotes**

> I love OpenAPI. <3

**Tables**

| Feature | Availability |
| ---------------- | ------------ |
| Markdown Support | ✓ |

**Accordion**

```html
<details>
<summary>Using Details Tags</summary>
<p>HTML Example</p>
</details>
```

**Images**

Yes, there's support for images, too!

![Empty placeholder image showing the width/height](https://images.placeholders.dev/?width=1280&height=720)

**Alerts**

> [!tip]
> You can now use markdown alerts in your descriptions.

</details>

<br />

## Contents

- [Installation](#installation)
- [Usage](#usage)
- [API Reference](./api.md)
- [Async](#async)
- [Authentication](#authentication)
- [Errors](#errors)
- [Client Options](#client-options)
- [Retries and Timeouts](#retries-and-timeouts)
- [Helpers](#helpers)
- [Logging](#logging)
- [Requirements](#requirements)

<br />

## Installation

```sh
pip install scalar-galaxy-py
```

<br />

## Usage

```python
import os

from scalar_galaxy_py import ScalarGalaxy

client = ScalarGalaxy(
bearer_auth=os.environ.get("BEARER_AUTH"),
)

planet = client.planets.list_all_data(
limit=10,
offset=0,
)
print(planet)
```

The examples in the following sections assume a `client` configured as shown above.

See the [API reference](./api.md) for every available operation.

<br />

## Async

Every client has an `Async` counterpart (`AsyncScalarGalaxy`) exposing the same resource tree with `await`.

```python
import asyncio

from scalar_galaxy_py import AsyncScalarGalaxy

async def main() -> None:
client = AsyncScalarGalaxy()
planet = await client.planets.list_all_data(
limit=10,
offset=0,
)

asyncio.run(main())
```

<br />

## Authentication

Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `bearer_auth` | `string \| provider` | - | JWT Bearer token authentication Defaults to BEARER_AUTH. |
| `basic_auth_username` | `string \| provider` | - | Basic HTTP authentication Defaults to BASIC_AUTH_USERNAME. |
| `api_key_header` | `string \| provider` | - | API key request header Defaults to API_KEY_HEADER. |
| `api_key_query` | `string \| provider` | - | API key query parameter Defaults to API_KEY_QUERY. |
| `api_key_cookie` | `string \| provider` | - | API key browser cookie Defaults to API_KEY_COOKIE. |
| `o_auth2` | `string \| provider` | - | OAuth 2.0 authentication Defaults to SCALAR_O_AUTH2. |
| `open_id_connect` | `string \| provider` | - | OpenID Connect Authentication Defaults to SCALAR_OPEN_ID_CONNECT. |

Declared schemes:

- `bearerAuth` bearer token
- `basicAuth` basic authentication
- `apiKeyHeader` API key in header `X-API-Key`
- `apiKeyQuery` API key in query `api_key`
- `apiKeyCookie` API key in cookie `api_key`
- `oAuth2` OAuth2/OpenID Connect
- `openIdConnect` OAuth2/OpenID Connect

<br />

## Errors

Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it.

```python
from scalar_galaxy_py import APIStatusError

try:
planet = client.planets.list_all_data(
limit=10,
offset=0,
)
except APIStatusError as err:
print(err.status_code, err.message)
raise
```

Documented error statuses: `400`, `401`, `403`, `404`, `409`, `422`.

<br />

## Client Options

Configure the generated client by setting any of these options when you create it.

```python
from scalar_galaxy_py import ScalarGalaxy

client = ScalarGalaxy(
timeout=60.0,
max_retries=2,
)
```

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `bearer_auth` | `str \| None` | `os.environ.get("BEARER_AUTH")` | JWT Bearer token authentication |
| `basic_auth_username` | `str \| None` | `os.environ.get("BASIC_AUTH_USERNAME")` | Basic HTTP authentication |
| `api_key_header` | `str \| None` | `os.environ.get("API_KEY_HEADER")` | API key request header |
| `api_key_query` | `str \| None` | `os.environ.get("API_KEY_QUERY")` | API key query parameter |
| `api_key_cookie` | `str \| None` | `os.environ.get("API_KEY_COOKIE")` | API key browser cookie |
| `o_auth2` | `str \| None` | `os.environ.get("SCALAR_O_AUTH2")` | OAuth 2.0 authentication |
| `open_id_connect` | `str \| None` | `os.environ.get("SCALAR_OPEN_ID_CONNECT")` | OpenID Connect Authentication |
| `base_url` | `str \| httpx.URL \| None` | - | Override the default API base URL. |
| `timeout` | `float \| Timeout \| None` | `60.0` | Maximum time in seconds to wait for a response before aborting a request. |
| `max_retries` | `int` | `2` | Number of retries for temporary failures. |
| `default_headers` | `Mapping[str, str] \| None` | - | Headers sent with every request. |
| `default_query` | `Mapping[str, object] \| None` | - | Query parameters sent with every request. |

<br />

## Retries and Timeouts

Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor `Retry-After` headers when present. Tune the retry and timeout client options shown above, or override them per request.

<br />

## Helpers

- Use `client.with_raw_response.<resource>.<method>(...)` to access the raw `httpx.Response` and parse it yourself.
- Use `client.with_streaming_response.<resource>.<method>(...)` to stream a response body without buffering it.

<br />

## Logging

- Set the `SCALAR_LOG` environment variable to `info` or `debug` to enable HTTP logging.
- Logs are emitted through the standard `logging` module under the `scalar_galaxy_py` logger.

<br />

## Requirements

- Python 3.8 or newer

Powered by Scalar.


## Contributions

This SDK is generated programmatically. Manual edits to generated files will be
overwritten on the next build.

### SDK created by [Scalar](https://www.scalar.com/?utm_source=demo-api-scalar-galaxy-python&utm_campaign=sdk)
3 changes: 3 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Security Policy

Please report any vulnerabilities through the standard issue tracker.
7 changes: 7 additions & 0 deletions VERSIONING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Versioning

This SDK is configured with the `manual` versioning policy.

- `manual`: package versions are set explicitly before release.
- `semver`: releases should follow semantic versioning based on API and SDK surface changes.
- `calendar`: releases should use a calendar-derived version chosen by the release workflow or maintainer.
Loading
Loading