xos-sdk 4.1.0__tar.gz

xos_sdk-4.1.0/LICENSE

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

xos_sdk-4.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: xos-sdk
+Version: 4.1.0
+Summary: Python SDK for the XOS public API.
+Author: GHXSTSHIP Industries LLC
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ghxstship/atlas/tree/main/packages/sdk-python
+Project-URL: Issues, https://github.com/ghxstship/atlas/issues
+Project-URL: Source, https://github.com/ghxstship/atlas/tree/main/packages/sdk-python
+Keywords: xos,atlas,api,sdk,openapi
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# xos-sdk
+
+The Python SDK for the XOS public API. Models, methods and the operation table are generated from the OpenAPI v1 document, so every operation in the API reference is a method. It uses only the standard library and runs on Python 3.9 or later.
+
+```sh
+pip install xos-sdk
+```
+
+## Use
+
+```python
+import os
+from xos_sdk import XosClient
+
+xos = XosClient("https://api.ghxstship.tech/v1", api_key=os.environ["XOS_API_KEY"])
+
+response = xos.projects.get(project_id)
+xos.projects.update(project_id, {"name": "Harborfront Fall Series"}, if_match=response.etag)
+
+for po in xos.purchase_orders.list_all(filter={"po_state": {"eq": "Approved"}}):
+    print(po["po_number"])
+```
+
+- Resources are snake_case attributes; `purchaseOrders.approve` is `xos.purchase_orders.approve(po_id, body)`.
+- POST methods send an `Idempotency-Key` and reuse it on retries; updates take `if_match`.
+- Rows are plain dictionaries typed as `TypedDict` models, and the package ships `py.typed`.
+
+## Documentation
+
+Guide: [Python SDK](https://github.com/ghxstship/atlas/blob/main/apps/docs/content/guides/en-US/python-sdk.md).
+
+## Versioning
+
+The package version follows the XOS release (`v4.0.0` publishes `4.0.0`). Within `/v1` the API changes only additively.
+
+## License
+
+MIT. See [LICENSE](LICENSE). The XOS platform itself is AGPL-3.0-only.

xos_sdk-4.1.0/README.md

@@ -0,0 +1,38 @@
+# xos-sdk
+
+The Python SDK for the XOS public API. Models, methods and the operation table are generated from the OpenAPI v1 document, so every operation in the API reference is a method. It uses only the standard library and runs on Python 3.9 or later.
+
+```sh
+pip install xos-sdk
+```
+
+## Use
+
+```python
+import os
+from xos_sdk import XosClient
+
+xos = XosClient("https://api.ghxstship.tech/v1", api_key=os.environ["XOS_API_KEY"])
+
+response = xos.projects.get(project_id)
+xos.projects.update(project_id, {"name": "Harborfront Fall Series"}, if_match=response.etag)
+
+for po in xos.purchase_orders.list_all(filter={"po_state": {"eq": "Approved"}}):
+    print(po["po_number"])
+```
+
+- Resources are snake_case attributes; `purchaseOrders.approve` is `xos.purchase_orders.approve(po_id, body)`.
+- POST methods send an `Idempotency-Key` and reuse it on retries; updates take `if_match`.
+- Rows are plain dictionaries typed as `TypedDict` models, and the package ships `py.typed`.
+
+## Documentation
+
+Guide: [Python SDK](https://github.com/ghxstship/atlas/blob/main/apps/docs/content/guides/en-US/python-sdk.md).
+
+## Versioning
+
+The package version follows the XOS release (`v4.0.0` publishes `4.0.0`). Within `/v1` the API changes only additively.
+
+## License
+
+MIT. See [LICENSE](LICENSE). The XOS platform itself is AGPL-3.0-only.

xos_sdk-4.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+# The XOS Python SDK. Runtime code is hand-written in src/xos_sdk/_runtime; src/xos_sdk/_generated
+# is produced from packages/api/openapi/v1.json by `pnpm --filter @ghxstship/xos-sdk generate` and never edited.
+# Standard library only: no runtime dependencies.
+
+[build-system]
+requires = ["setuptools==80.9.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xos-sdk"
+version = "4.1.0"
+description = "Python SDK for the XOS public API."
+readme = "README.md"
+authors = [{ name = "GHXSTSHIP Industries LLC" }]
+keywords = ["xos", "atlas", "api", "sdk", "openapi"]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+dependencies = []
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/ghxstship/atlas/tree/main/packages/sdk-python"
+Issues = "https://github.com/ghxstship/atlas/issues"
+Source = "https://github.com/ghxstship/atlas/tree/main/packages/sdk-python"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+xos_sdk = ["py.typed"]

xos_sdk-4.1.0/setup.cfg

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

xos_sdk-4.1.0/src/xos_sdk/__init__.py

@@ -0,0 +1,83 @@
+"""``xos-sdk``: the Python SDK for the XOS public API.
+
+The runtime (transport, errors, pagination, webhooks) is hand-written; everything under
+``_generated`` is produced from ``packages/api/openapi/v1.json`` and never edited by hand.
+"""
+
+from ._generated.client import XosClient
+from ._generated.operations import API_TITLE, API_VERSION, OPERATIONS, RESOURCES
+from ._runtime.client import Resource, XosClientCore
+from ._runtime.errors import (
+    XosApiError,
+    XosAuthenticationError,
+    XosBadRequestError,
+    XosConflictError,
+    XosError,
+    XosNetworkError,
+    XosNotFoundError,
+    XosPreconditionFailedError,
+    XosPreconditionRequiredError,
+    XosRateLimitError,
+    XosRefusalError,
+    XosServerError,
+    XosValidationError,
+    error_for_problem,
+    parse_retry_after,
+)
+from ._runtime.types import (
+    FILTER_OPERATORS,
+    ApiResponse,
+    Headers,
+    OperationSpec,
+    Page,
+    RateLimit,
+    RequestOptions,
+)
+from ._runtime.webhooks import (
+    DEFAULT_TOLERANCE_SECONDS,
+    SIGNATURE_HEADER,
+    WebhookVerification,
+    parse_signature_header,
+    sign_webhook_payload,
+    verify_webhook_signature,
+)
+
+__version__ = "4.1.0"
+
+__all__ = [
+    "API_TITLE",
+    "API_VERSION",
+    "DEFAULT_TOLERANCE_SECONDS",
+    "FILTER_OPERATORS",
+    "OPERATIONS",
+    "RESOURCES",
+    "SIGNATURE_HEADER",
+    "ApiResponse",
+    "Headers",
+    "OperationSpec",
+    "Page",
+    "RateLimit",
+    "RequestOptions",
+    "Resource",
+    "WebhookVerification",
+    "XosApiError",
+    "XosAuthenticationError",
+    "XosBadRequestError",
+    "XosClient",
+    "XosClientCore",
+    "XosConflictError",
+    "XosError",
+    "XosNetworkError",
+    "XosNotFoundError",
+    "XosPreconditionFailedError",
+    "XosPreconditionRequiredError",
+    "XosRateLimitError",
+    "XosRefusalError",
+    "XosServerError",
+    "XosValidationError",
+    "error_for_problem",
+    "parse_retry_after",
+    "parse_signature_header",
+    "sign_webhook_payload",
+    "verify_webhook_signature",
+]

xos_sdk-4.1.0/src/xos_sdk/_generated/__init__.py

@@ -0,0 +1,2 @@
+# Generated by @ghxstship/xos-sdk codegen from packages/api/openapi/v1.json. Do not edit; run `pnpm --filter @ghxstship/xos-sdk generate`.
+"""Generated modules. Import from ``xos_sdk`` instead."""