hyze-cloud 0.1.0__py3-none-any.whl

hyze_cloud-0.1.0.dist-info/METADATA

@@ -0,0 +1,263 @@
+Metadata-Version: 2.5
+Name: hyze-cloud
+Version: 0.1.0
+Summary: Official Python SDK for the Hyze Cloud API
+Project-URL: Homepage, https://hyzecloud.com
+Project-URL: Documentation, https://docs.hyzecloud.app
+Project-URL: Repository, https://github.com/Hyze-Cloud/hyzecloud-sdk-python
+Project-URL: Issues, https://github.com/Hyze-Cloud/hyzecloud-sdk-python/issues
+Project-URL: Changelog, https://github.com/Hyze-Cloud/hyzecloud-sdk-python/releases
+Author: Hyze Cloud
+License-File: LICENSE
+Keywords: api,deploy,hyze,hyzecloud,paas,python,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# hyze-cloud
+
+[![CI](https://github.com/Hyze-Cloud/hyzecloud-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/Hyze-Cloud/hyzecloud-sdk-python/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/hyze-cloud)](https://pypi.org/project/hyze-cloud/)
+[![Python versions](https://img.shields.io/pypi/pyversions/hyze-cloud)](https://pypi.org/project/hyze-cloud/)
+[![license](https://img.shields.io/badge/license-MIT-blue)](./LICENSE)
+
+Official **Python** SDK for the [Hyze Cloud API](https://docs.hyzecloud.app).
+
+- **Sync and async** clients with the same surface — `client.apps.list()` or `await`
+- Typed helpers for apps, databases, API keys, invoices, GitHub and plans
+- One dependency (`httpx`), and it is the only one
+- Consistent `HyzeError` carrying status, code and `Retry-After`
+- Ships `py.typed`, so editors and type checkers see the shapes
+
+This is a port of the TypeScript SDK ([`@hyze-cloud/sdk`](https://github.com/Hyze-Cloud/hyzecloud-sdk-ts)):
+same resources, same routes, same error shape. The one naming difference is deliberate — Python
+callers use `snake_case` (`memory_mb`) and the SDK translates it to the API's `camelCase`
+(`memoryMB`).
+
+## Install
+
+```bash
+pip install hyze-cloud
+# or
+uv add hyze-cloud
+```
+
+Requires **Python 3.10+**.
+
+## Quickstart
+
+```python
+from hyzecloud import HyzeCloud, HyzeError
+
+client = HyzeCloud(
+    # api_key="hyze_...",                       # defaults to $HYZE_API_KEY
+    # base_url="https://api.hyzecloud.com/api", # the default
+    # workspace_id="org_...",                   # optional scope
+)
+
+for app in client.apps.list()["apps"]:
+    print(app["name"], app["status"])
+
+try:
+    client.apps.restart("app_001")
+except HyzeError as err:
+    print(err.status, err.code, err.message)
+    if err.is_rate_limited:
+        print("retry after", err.retry_after_seconds)
+    raise
+```
+
+Close the client when you are done, or use it as a context manager:
+
+```python
+with HyzeCloud() as client:
+    client.plans.current()
+```
+
+## Async
+
+The same calls, awaited. `AsyncHyzeCloud` is the client to reach for inside FastAPI, aiohttp or
+any asyncio program:
+
+```python
+import asyncio
+from hyzecloud import AsyncHyzeCloud
+
+
+async def main() -> None:
+    async with AsyncHyzeCloud() as client:
+        apps = await client.apps.list()
+        print(len(apps["apps"]))
+
+
+asyncio.run(main())
+```
+
+## Apps
+
+```python
+# List / get
+apps = client.apps.list()["apps"]
+detail = client.apps.get("app_001")["container"]
+
+# Lifecycle
+client.apps.start("app_001")
+client.apps.stop("app_001")
+client.apps.restart("app_001")
+
+# Logs, env, deploy history
+client.apps.logs("app_001", tail=200, timestamps=True)
+client.apps.get_env("app_001")
+client.apps.set_env("app_001", {"NODE_ENV": "production"})
+client.apps.deployments("app_001", limit=30)
+
+# Deploy from a ZIP — a path, raw bytes, or an open file all work.
+# A path is read into memory; pass an open file for a large archive (it gets streamed).
+client.apps.deploy_from_zip(
+    file="./app.zip",
+    name="my-api",
+    runtime="python",
+    memory_mb=512,
+    expose_port=8000,
+    subdomain="my-api",
+    # startup_command omitted (or "auto") -> Hyze detects the start command
+)
+
+# Detect the env vars of a ZIP without deploying it
+client.apps.inspect_env("./app.zip")
+
+# Deploy from a connected GitHub repository
+client.apps.deploy_from_repo(
+    name="my-api",
+    runtime="python",
+    memory_mb=512,
+    repository={"id": 123, "owner": "acme", "name": "api", "branch": "main"},
+)
+
+# Backups
+client.apps.create_backup("app_001")
+client.apps.list_backups("app_001")
+client.apps.restore_backup("app_001", "backup_001")
+```
+
+## Databases
+
+```python
+client.databases.create(name="prod-postgres", engine="postgresql", memory_mb=1024, storage_gb=20)
+client.databases.list()
+client.databases.stats("db_001")
+client.databases.rotate_password("db_001")
+client.databases.create_backup("db_001")
+client.databases.restore("db_001", "backup_001")
+```
+
+## API keys, invoices, GitHub, plans
+
+```python
+keys = client.api_keys.list()["keys"]
+created = client.api_keys.create(name="ci")
+# created["key"]["key"] is the one-time secret — it is never returned again
+
+invoices = client.invoices.list()["invoices"]
+pix = client.invoices.create_pix(plan_id="pro", interval="month")
+# pix["invoice"]["brCode"] / ["brCodeBase64"] for the checkout screen
+client.invoices.status(pix["invoice"]["id"], include_pix=True)
+
+client.github.status()
+client.github.repos()
+client.github.branches("acme", "api")
+client.github.detect_runtime("acme", "api", branch="main")
+
+current = client.plans.current()  # plan + usage, no nested apps/databases lists
+client.plans.list()
+```
+
+## Error handling
+
+Every failure raises `HyzeError`, including a 2xx response whose body is shaped like an error.
+
+| Attribute | Meaning |
+| --- | --- |
+| `status` | HTTP status (401 when a 2xx body looked like an error) |
+| `code` | Structured code from the payload, when the API sent one |
+| `message` | Human-readable message |
+| `body` | The decoded payload, untouched |
+| `retry_after_seconds` | From the `Retry-After` header, when present |
+
+`is_rate_limited` (`429`), `is_unauthorized` (`401`/`403`) and `is_not_found` (`404`) are there so
+callers do not have to compare numbers by hand.
+
+## Low-level access
+
+```python
+client.get("/apps/")
+client.post("/apps/app_001/restart")
+client.request("GET", "/apps/", query={"workspaceId": "org_1"})
+```
+
+## Environment
+
+| Variable | Description |
+| --- | --- |
+| `HYZE_API_KEY` | Default API key when `api_key` is omitted |
+| `HYZE_API_URL` | Override the base URL (default `https://api.hyzecloud.com/api`) |
+
+## Development
+
+```bash
+uv venv && uv pip install -e ".[dev]"
+.venv/bin/python -m pytest
+.venv/bin/python -m mypy
+.venv/bin/python -m ruff check .
+.venv/bin/python scripts/check_api_routes.py   # are the routes this SDK calls still there?
+```
+
+`check_api_routes.py` hits the production API **unauthenticated**: a 404 means the route is gone,
+any other status (401/400/…) means it exists. It runs on every PR and before publishing — a
+published client calling a dead route is a 404 for the user.
+
+### Live smoke test
+
+Exercises the read paths against the real API with your key:
+
+```bash
+HYZE_API_KEY=hyze_xxx .venv/bin/python scripts/live_smoke.py
+```
+
+## Release
+
+The tag drives the version: `vX.Y.Z` must match `pyproject.toml`, otherwise the workflow aborts
+before publishing.
+
+```bash
+# bump the version, then
+git tag v0.1.1 && git push origin v0.1.1
+```
+
+`release.yml` runs ruff + mypy + pytest + `check_api_routes.py`, builds the sdist and the wheel,
+and publishes to PyPI through **Trusted Publishing** (OIDC) — there is no API token stored anywhere.
+
+## Docs
+
+- [Hyze Cloud Docs](https://docs.hyzecloud.app)
+- [API introduction](https://docs.hyzecloud.app/api-reference/introduction)
+- [Rate limits](https://docs.hyzecloud.app/en/concepts/rate-limits)
+
+## License
+
+MIT

hyze_cloud-0.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+hyzecloud/__init__.py,sha256=IYhNXJc_qk9Eul_E5AM7U7je_p-hlpTIR5thKfEnuW0,3465
+hyzecloud/_url.py,sha256=kRXIvKbHDHAiHk8aWXHe0Bw-U_oPBxn6cbrxjdR-5Fs,828
+hyzecloud/client.py,sha256=-DAFoJe-UzHaVbDPr9_smx-b2W8FbikIc4a0TBJgspc,13936
+hyzecloud/errors.py,sha256=QKZIqDMeGZfuWi5oGO-ll343Bvd5Fb2v1LchM53llCM,3466
+hyzecloud/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hyzecloud/types.py,sha256=kNKV7QJkrtQJnTPpThk-6Tinq8j86g7wKVACQi-hdCk,10437
+hyzecloud/resources/__init__.py,sha256=-2gJMZE_oxaoLSu3u9vBWlkhJgv_aqjg_k2QAHPC0xw,665
+hyzecloud/resources/api_keys.py,sha256=ef_vOIT4SoAkjUaB1mXl88NaK8QiCqp25Hiaz0EiN38,2095
+hyzecloud/resources/apps.py,sha256=TBj0bgXYiTscoEVrAQ5BepOFP8JuGwhVwZxzXjl2Ih0,9096
+hyzecloud/resources/databases.py,sha256=51cA6ImkIjFX8s7pVXs_X1EQJc1HGAVtskPJmYNZyBI,5203
+hyzecloud/resources/github.py,sha256=5TvHRvNQFYN_if5AJVxRMUg9OCn-bOtABbgJnWyp598,1832
+hyzecloud/resources/invoices.py,sha256=uYnAyIHNyXVFBrykcVlD9qfJ1-OK6iVjnG8ht2CRsho,1349
+hyzecloud/resources/plans.py,sha256=3DI0_9RGC6QycIdPadWoD9Im2bksYW4SiXyaYOLNcD8,713
+hyze_cloud-0.1.0.dist-info/METADATA,sha256=AQ_ZHnWJ3rRa4Myx9pHC2tXO4MSIofTXIZDPqwyZH3k,8229
+hyze_cloud-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+hyze_cloud-0.1.0.dist-info/licenses/LICENSE,sha256=A0cg9rg53IWNTe-qsGjEexNWxA-SY3z0kjUXyRISdS0,1067
+hyze_cloud-0.1.0.dist-info/RECORD,,

hyze_cloud-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

hyze_cloud-0.1.0.dist-info/licenses/LICENSE

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

hyzecloud/__init__.py

@@ -0,0 +1,143 @@
+"""Official Python SDK for the Hyze Cloud API.
+
+    from hyzecloud import HyzeCloud
+
+    client = HyzeCloud(api_key="hyze_...")
+    for app in client.apps.list()["apps"]:
+        print(app["name"], app["status"])
+
+An async client with the same surface is available as :class:`AsyncHyzeCloud`:
+
+    from hyzecloud import AsyncHyzeCloud
+
+    async with AsyncHyzeCloud() as client:   # reads HYZE_API_KEY
+        apps = await client.apps.list()
+
+This mirrors the TypeScript SDK (``@hyze-cloud/sdk``): same resources, same routes, same
+error shape.
+"""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as _version
+
+from .client import DEFAULT_BASE_URL, DEFAULT_TIMEOUT, AsyncHyzeCloud, HyzeCloud, create_hyze_client
+from .errors import HyzeError, looks_like_error_payload, parse_error_body
+from .resources import (
+    ApiKeysResource,
+    AppsResource,
+    DatabasesResource,
+    GithubResource,
+    InvoicesResource,
+    PlansResource,
+)
+from .types import (
+    ApiKeyCreated,
+    ApiKeyCreateResponse,
+    ApiKeyItem,
+    ApiKeysListResponse,
+    ApiKeyUpdateResponse,
+    AppDeployment,
+    AppDeploymentsResponse,
+    AppDeploymentStatus,
+    AppDetail,
+    AppDetailResponse,
+    AppEnvResponse,
+    AppListItem,
+    AppLogsResponse,
+    AppsListResponse,
+    BillingInterval,
+    ContainerStats,
+    CreateApiKeyInput,
+    CreateDatabaseInput,
+    CreatePixInvoiceInput,
+    CurrentPlanResponse,
+    DatabaseEngine,
+    DatabaseItem,
+    DatabaseResponse,
+    DatabasesListResponse,
+    DeployFromRepoInput,
+    DeployFromZipInput,
+    DeployRepository,
+    GithubStatusResponse,
+    InvoiceBilling,
+    InvoiceDetail,
+    InvoiceDetailResponse,
+    InvoiceListItem,
+    InvoicePlanSummary,
+    InvoicesListResponse,
+    PlanInfo,
+    PlanPriceInfo,
+    PlansListResponse,
+    PlanUsage,
+    RequestOptions,
+    Runtime,
+    UpdateApiKeyInput,
+    UpdateAppSettingsInput,
+)
+
+try:
+    __version__ = _version("hyze-cloud")
+except PackageNotFoundError:  # running from a source tree without an install
+    __version__ = "0.0.0"
+
+__all__ = [
+    "DEFAULT_BASE_URL",
+    "DEFAULT_TIMEOUT",
+    "ApiKeyCreateResponse",
+    "ApiKeyCreated",
+    "ApiKeyItem",
+    "ApiKeyUpdateResponse",
+    "ApiKeysListResponse",
+    "ApiKeysResource",
+    "AppDeployment",
+    "AppDeploymentStatus",
+    "AppDeploymentsResponse",
+    "AppDetail",
+    "AppDetailResponse",
+    "AppEnvResponse",
+    "AppListItem",
+    "AppLogsResponse",
+    "AppsListResponse",
+    "AppsResource",
+    "AsyncHyzeCloud",
+    "BillingInterval",
+    "ContainerStats",
+    "CreateApiKeyInput",
+    "CreateDatabaseInput",
+    "CreatePixInvoiceInput",
+    "CurrentPlanResponse",
+    "DatabaseEngine",
+    "DatabaseItem",
+    "DatabaseResponse",
+    "DatabasesListResponse",
+    "DatabasesResource",
+    "DeployFromRepoInput",
+    "DeployFromZipInput",
+    "DeployRepository",
+    "GithubResource",
+    "GithubStatusResponse",
+    "HyzeCloud",
+    "HyzeError",
+    "InvoiceBilling",
+    "InvoiceDetail",
+    "InvoiceDetailResponse",
+    "InvoiceListItem",
+    "InvoicePlanSummary",
+    "InvoicesListResponse",
+    "InvoicesResource",
+    "PlanInfo",
+    "PlanPriceInfo",
+    "PlanUsage",
+    "PlansListResponse",
+    "PlansResource",
+    "RequestOptions",
+    "Runtime",
+    "UpdateApiKeyInput",
+    "UpdateAppSettingsInput",
+    "__version__",
+    "create_hyze_client",
+    "looks_like_error_payload",
+    "parse_error_body",
+]

hyzecloud/_url.py

@@ -0,0 +1,26 @@
+"""URL helpers shared by the client and the resources.
+
+Kept in its own module so resources can import it without importing the client, which
+would be a cycle (the client imports every resource).
+"""
+
+from __future__ import annotations
+
+from urllib.parse import quote
+
+__all__ = ["join_url", "segment"]
+
+
+def join_url(base: str, path: str) -> str:
+    """Append a path to a base URL without doubling or dropping the slash."""
+    normalized_path = path if path.startswith("/") else f"/{path}"
+    return f"{base.rstrip('/')}{normalized_path}"
+
+
+def segment(value: object) -> str:
+    """Percent-encode one path segment.
+
+    The TypeScript SDK wraps every id in ``encodeURIComponent``. Without this, an id
+    containing a space, a slash or a ``?`` would silently change the route.
+    """
+    return quote(str(value), safe="")