unitysvc-py 0.1.0__tar.gz

unitysvc_py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026, Bo Peng
+
+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.

unitysvc_py-0.1.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: unitysvc-py
+Version: 0.1.0
+Summary: Customer-facing Python SDK and `usvc` CLI for UnitySVC
+Author-email: Bo Peng <bo.peng@unitysvc.com>
+Maintainer-email: Bo Peng <bo.peng@unitysvc.com>
+License-Expression: MIT
+Project-URL: bugs, https://github.com/unitysvc/unitysvc-py/issues
+Project-URL: homepage, https://github.com/unitysvc/unitysvc-py
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Requires-Dist: rich
+Requires-Dist: httpx>=0.24
+Requires-Dist: attrs>=23.0
+Requires-Dist: python-dateutil>=2.8
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: respx; extra == "test"
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: ipdb; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocs-autorefs; extra == "docs"
+Requires-Dist: pymdown-extensions; extra == "docs"
+Dynamic: license-file
+
+# unitysvc-py
+
+Customer-facing Python SDK and `usvc` CLI for [UnitySVC](https://unitysvc.com/).
+
+This package is a thin, typed facade over the UnitySVC customer API.
+It exposes:
+
+- A sync [`Client`](#programmatic-usage) and async `AsyncClient` for
+  the customer-tagged backend endpoints.
+- The `usvc` CLI for managing the same resources from the terminal.
+
+> **Status:** early scaffolding. The customer API currently exposes
+> only a handful of endpoints (aliases, recurrent requests, secrets);
+> the SDK tracks those today and will grow as the backend adds more.
+
+## Install
+
+```bash
+pip install unitysvc-py
+```
+
+## Programmatic usage
+
+```python
+from unitysvc_py import Client
+
+client = Client(api_key="svcpass_...")  # or Client.from_env()
+
+# List and set secrets
+secrets = client.secrets.list()
+for s in secrets.data:
+    print(s.name, s.id)
+
+client.secrets.create({"name": "openai-key", "value": "sk-..."})
+```
+
+### Configuration
+
+The SDK is configured via a small set of environment variables. Only
+`UNITYSVC_API_KEY` is required; everything else has a sensible
+default.
+
+| Variable                 | Purpose                                     | Default                                      |
+|--------------------------|---------------------------------------------|----------------------------------------------|
+| `UNITYSVC_API_KEY`       | Customer API key (`svcpass_...`)            | (required)                                   |
+| `UNITYSVC_API_URL`       | Control-plane API base URL                  | `https://api.staging.unitysvc.com/v1`   |
+| `UNITYSVC_API_BASE_URL`  | HTTP API gateway base URL (inference)       | (unset)                                      |
+| `UNITYSVC_S3_BASE_URL`   | S3-compatible gateway base URL              | (unset)                                      |
+| `UNITYSVC_SMTP_BASE_URL` | SMTP gateway base URL                       | (unset)                                      |
+
+The customer context is encoded entirely in the API key, so no
+separate `customer_id` argument is required.
+
+`UNITYSVC_API_URL` is what the SDK itself uses for control-plane
+calls. The `*_BASE_URL` variables are exposed on `Client` as
+`client.api_base_url`, `client.s3_base_url`, `client.smtp_base_url`
+for downstream inference/storage/email SDKs to pick up — the SDK
+itself doesn't talk to them directly.
+
+### Async client
+
+```python
+import asyncio
+from unitysvc_py import AsyncClient
+
+async def main():
+    async with AsyncClient(api_key="svcpass_...") as client:
+        secrets = await client.secrets.list()
+        for s in secrets.data:
+            print(s.name)
+
+asyncio.run(main())
+```
+
+### Errors
+
+All errors are subclasses of `unitysvc_py.UnitysvcSDKError`:
+
+```python
+from unitysvc_py import (
+    UnitysvcSDKError,
+    AuthenticationError,   # 401
+    PermissionError,       # 403
+    NotFoundError,         # 404
+    ValidationError,       # 400, 422
+    ConflictError,         # 409
+    RateLimitError,        # 429
+    ServerError,           # 5xx
+    APIError,              # base for everything above
+)
+```
+
+## CLI: `usvc`
+
+The CLI follows the SDK's configuration — set `UNITYSVC_API_KEY` (and
+optionally `UNITYSVC_API_URL`) and you can run:
+
+```
+usvc env                              # show which env vars the SDK will pick up
+
+# Secrets
+usvc secrets list                     # list secrets
+usvc secrets set NAME --value V       # create or update a secret by name
+usvc secrets delete NAME              # delete a secret by name
+
+# Service aliases
+usvc aliases list
+usvc aliases show ALIAS_ID
+usvc aliases delete ALIAS_ID
+
+# Recurrent requests
+usvc recurrent-requests list
+usvc recurrent-requests show REQUEST_ID
+usvc recurrent-requests trigger REQUEST_ID
+usvc recurrent-requests delete REQUEST_ID
+```
+
+Every command accepts `--api-key` and `--base-url` overrides.
+
+## Layout
+
+```
+src/unitysvc_py/
+├── client.py          # Client (sync) facade
+├── aclient.py         # AsyncClient (async) facade
+├── exceptions.py      # UnitysvcSDKError + status-code subclasses
+├── _http.py           # internal: unwrap generated Response → typed model or APIError
+├── resources/
+│   ├── secrets.py             # client.secrets.*
+│   ├── aliases.py             # client.aliases.*
+│   ├── recurrent_requests.py  # client.recurrent_requests.*
+│   ├── asecrets.py            # async mirror
+│   ├── aaliases.py            # async mirror
+│   └── arecurrent_requests.py # async mirror
+├── _generated/        # openapi-python-client output (do not edit by hand)
+├── commands/          # Typer command groups for the CLI
+│   ├── _helpers.py    #   run_async, async_client, model_list, ...
+│   └── secrets.py     #   `usvc secrets {list,set,delete}`
+└── cli.py             # `usvc` Typer entry point
+```
+
+## Regenerating the API client
+
+The low-level client under `src/unitysvc_py/_generated/` is produced
+by [openapi-python-client] from a copy of the backend OpenAPI spec at
+`openapi.json`. To regenerate after a backend change:
+
+```bash
+# Requires a sibling checkout of unitysvc/unitysvc
+./scripts/generate_client.sh
+```
+
+The script reads `../unitysvc/backend/generated/customer_api.json` by
+default; pass an explicit spec path as the first argument to override.
+
+[openapi-python-client]: https://github.com/openapi-generators/openapi-python-client
+
+## License
+
+MIT

unitysvc_py-0.1.0/README.md

@@ -0,0 +1,160 @@
+# unitysvc-py
+
+Customer-facing Python SDK and `usvc` CLI for [UnitySVC](https://unitysvc.com/).
+
+This package is a thin, typed facade over the UnitySVC customer API.
+It exposes:
+
+- A sync [`Client`](#programmatic-usage) and async `AsyncClient` for
+  the customer-tagged backend endpoints.
+- The `usvc` CLI for managing the same resources from the terminal.
+
+> **Status:** early scaffolding. The customer API currently exposes
+> only a handful of endpoints (aliases, recurrent requests, secrets);
+> the SDK tracks those today and will grow as the backend adds more.
+
+## Install
+
+```bash
+pip install unitysvc-py
+```
+
+## Programmatic usage
+
+```python
+from unitysvc_py import Client
+
+client = Client(api_key="svcpass_...")  # or Client.from_env()
+
+# List and set secrets
+secrets = client.secrets.list()
+for s in secrets.data:
+    print(s.name, s.id)
+
+client.secrets.create({"name": "openai-key", "value": "sk-..."})
+```
+
+### Configuration
+
+The SDK is configured via a small set of environment variables. Only
+`UNITYSVC_API_KEY` is required; everything else has a sensible
+default.
+
+| Variable                 | Purpose                                     | Default                                      |
+|--------------------------|---------------------------------------------|----------------------------------------------|
+| `UNITYSVC_API_KEY`       | Customer API key (`svcpass_...`)            | (required)                                   |
+| `UNITYSVC_API_URL`       | Control-plane API base URL                  | `https://api.staging.unitysvc.com/v1`   |
+| `UNITYSVC_API_BASE_URL`  | HTTP API gateway base URL (inference)       | (unset)                                      |
+| `UNITYSVC_S3_BASE_URL`   | S3-compatible gateway base URL              | (unset)                                      |
+| `UNITYSVC_SMTP_BASE_URL` | SMTP gateway base URL                       | (unset)                                      |
+
+The customer context is encoded entirely in the API key, so no
+separate `customer_id` argument is required.
+
+`UNITYSVC_API_URL` is what the SDK itself uses for control-plane
+calls. The `*_BASE_URL` variables are exposed on `Client` as
+`client.api_base_url`, `client.s3_base_url`, `client.smtp_base_url`
+for downstream inference/storage/email SDKs to pick up — the SDK
+itself doesn't talk to them directly.
+
+### Async client
+
+```python
+import asyncio
+from unitysvc_py import AsyncClient
+
+async def main():
+    async with AsyncClient(api_key="svcpass_...") as client:
+        secrets = await client.secrets.list()
+        for s in secrets.data:
+            print(s.name)
+
+asyncio.run(main())
+```
+
+### Errors
+
+All errors are subclasses of `unitysvc_py.UnitysvcSDKError`:
+
+```python
+from unitysvc_py import (
+    UnitysvcSDKError,
+    AuthenticationError,   # 401
+    PermissionError,       # 403
+    NotFoundError,         # 404
+    ValidationError,       # 400, 422
+    ConflictError,         # 409
+    RateLimitError,        # 429
+    ServerError,           # 5xx
+    APIError,              # base for everything above
+)
+```
+
+## CLI: `usvc`
+
+The CLI follows the SDK's configuration — set `UNITYSVC_API_KEY` (and
+optionally `UNITYSVC_API_URL`) and you can run:
+
+```
+usvc env                              # show which env vars the SDK will pick up
+
+# Secrets
+usvc secrets list                     # list secrets
+usvc secrets set NAME --value V       # create or update a secret by name
+usvc secrets delete NAME              # delete a secret by name
+
+# Service aliases
+usvc aliases list
+usvc aliases show ALIAS_ID
+usvc aliases delete ALIAS_ID
+
+# Recurrent requests
+usvc recurrent-requests list
+usvc recurrent-requests show REQUEST_ID
+usvc recurrent-requests trigger REQUEST_ID
+usvc recurrent-requests delete REQUEST_ID
+```
+
+Every command accepts `--api-key` and `--base-url` overrides.
+
+## Layout
+
+```
+src/unitysvc_py/
+├── client.py          # Client (sync) facade
+├── aclient.py         # AsyncClient (async) facade
+├── exceptions.py      # UnitysvcSDKError + status-code subclasses
+├── _http.py           # internal: unwrap generated Response → typed model or APIError
+├── resources/
+│   ├── secrets.py             # client.secrets.*
+│   ├── aliases.py             # client.aliases.*
+│   ├── recurrent_requests.py  # client.recurrent_requests.*
+│   ├── asecrets.py            # async mirror
+│   ├── aaliases.py            # async mirror
+│   └── arecurrent_requests.py # async mirror
+├── _generated/        # openapi-python-client output (do not edit by hand)
+├── commands/          # Typer command groups for the CLI
+│   ├── _helpers.py    #   run_async, async_client, model_list, ...
+│   └── secrets.py     #   `usvc secrets {list,set,delete}`
+└── cli.py             # `usvc` Typer entry point
+```
+
+## Regenerating the API client
+
+The low-level client under `src/unitysvc_py/_generated/` is produced
+by [openapi-python-client] from a copy of the backend OpenAPI spec at
+`openapi.json`. To regenerate after a backend change:
+
+```bash
+# Requires a sibling checkout of unitysvc/unitysvc
+./scripts/generate_client.sh
+```
+
+The script reads `../unitysvc/backend/generated/customer_api.json` by
+default; pass an explicit spec path as the first argument to override.
+
+[openapi-python-client]: https://github.com/openapi-generators/openapi-python-client
+
+## License
+
+MIT

unitysvc_py-0.1.0/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "unitysvc-py"
+version = "0.1.0"
+description = "Customer-facing Python SDK and `usvc` CLI for UnitySVC"
+readme = "README.md"
+authors = [{ name = "Bo Peng", email = "bo.peng@unitysvc.com" }]
+maintainers = [{ name = "Bo Peng", email = "bo.peng@unitysvc.com" }]
+license = "MIT"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Operating System :: OS Independent",
+  "Typing :: Typed",
+]
+dependencies = [
+  "typer",
+  "rich",
+  "httpx>=0.24",
+  "attrs>=23.0",
+  "python-dateutil>=2.8",
+]
+requires-python = ">= 3.11"
+
+[project.optional-dependencies]
+test = [
+  "coverage",
+  "pytest",
+  "pytest-asyncio",
+  "ruff",
+  "mypy",
+  "respx",
+]
+dev = [
+  "coverage",
+  "pytest",
+  "ruff",
+  "ipdb",
+]
+docs = [
+  "mkdocs",
+  "mkdocs-material",
+  "mkdocs-autorefs",
+  "pymdown-extensions",
+]
+
+[project.urls]
+bugs = "https://github.com/unitysvc/unitysvc-py/issues"
+homepage = "https://github.com/unitysvc/unitysvc-py"
+
+[project.scripts]
+usvc = "unitysvc_py.cli:app"
+
+[tool.ruff]
+line-length = 120
+# openapi-python-client produces its own idiosyncratic formatting.
+# Excluding keeps regenerations byte-stable — no post-processing
+# step, no drift between the spec and the committed client.
+extend-exclude = ["src/unitysvc_py/_generated"]
+
+[tool.ruff.lint]
+select = [
+  "E",  # pycodestyle errors
+  "W",  # pycodestyle warnings
+  "F",  # Pyflakes
+  "I",  # isort
+  "B",  # flake8-bugbear
+  "UP", # pyupgrade
+]
+ignore = [
+  "B008", # Typer pattern uses function calls in argument defaults
+  "B904",
+]
+
+[tool.mypy]
+ignore_missing_imports = true
+warn_unused_ignores = false
+disable_error_code = ["import-untyped"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+unitysvc_py = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

unitysvc_py-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

unitysvc_py-0.1.0/src/unitysvc_py/__init__.py

@@ -0,0 +1,68 @@
+"""UnitySVC Python SDK — customer-facing tools for UnitySVC.
+
+This package provides:
+
+- The :class:`Client` / :class:`AsyncClient` HTTP SDK targeting the
+  customer-tagged ``/v1/customer/*`` endpoints (aliases, recurrent
+  requests, secrets).
+- The ``usvc`` CLI for managing the same resources from the terminal.
+
+Quick start::
+
+    from unitysvc_py import Client
+
+    client = Client(api_key="svcpass_...")
+    secrets = client.secrets.list()
+
+The customer context is encoded entirely in the API key, so no
+separate ``customer_id`` is required. The default base URL points at
+the staging environment; override with the ``base_url`` constructor
+argument or the ``UNITYSVC_API_URL`` env var.
+"""
+
+from .aclient import AsyncClient
+from .client import (
+    DEFAULT_API_URL,
+    ENV_API_BASE_URL,
+    ENV_API_KEY,
+    ENV_API_URL,
+    ENV_S3_BASE_URL,
+    ENV_SMTP_BASE_URL,
+    Client,
+)
+from .exceptions import (
+    APIError,
+    AuthenticationError,
+    ConflictError,
+    NotFoundError,
+    PermissionError,
+    RateLimitError,
+    ServerError,
+    UnitysvcSDKError,
+    ValidationError,
+)
+
+__author__ = """Bo Peng"""
+__email__ = "bo.peng@unitysvc.com"
+
+__all__ = [
+    # Client
+    "Client",
+    "AsyncClient",
+    "DEFAULT_API_URL",
+    "ENV_API_KEY",
+    "ENV_API_URL",
+    "ENV_API_BASE_URL",
+    "ENV_S3_BASE_URL",
+    "ENV_SMTP_BASE_URL",
+    # Exceptions
+    "UnitysvcSDKError",
+    "APIError",
+    "AuthenticationError",
+    "PermissionError",
+    "NotFoundError",
+    "ValidationError",
+    "ConflictError",
+    "RateLimitError",
+    "ServerError",
+]

unitysvc_py-0.1.0/src/unitysvc_py/_generated/__init__.py

@@ -0,0 +1,8 @@
+
+""" A client library for accessing UnitySVC Customer API """
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

unitysvc_py-0.1.0/src/unitysvc_py/_generated/api/__init__.py

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

unitysvc_py-0.1.0/src/unitysvc_py/_generated/api/customer_aliases/__init__.py

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