openmates 0.14.0a0__tar.gz

openmates-0.14.0a0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: openmates
+Version: 0.14.0a0
+Summary: OpenMates Python SDK
+License-Expression: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.31
+Requires-Dist: cryptography>=41
+
+# openmates
+
+Python SDK for OpenMates API-key access to app skills and encrypted chat workflows.
+
+## Install
+
+```bash
+pip install openmates
+```
+
+## API Key
+
+Create an API key in OpenMates under Settings > Developers > API Keys. The guided flow asks for scope, credit limit, and expiration before revealing the key once.
+
+Set the key in your environment:
+
+```bash
+export OPENMATES_API_KEY="sk-api-..."
+```
+
+New SDK devices are blocked until approved in Settings > Developers > Devices.
+
+## Usage
+
+```python
+from openmates import OpenMates
+
+om = OpenMates()  # reads OPENMATES_API_KEY
+
+result = om.apps.web.search({
+    "requests": [{"query": "OpenMates SDK examples"}],
+})
+```
+
+SDK methods authenticate lazily; there is no `connect()` call.
+
+List encrypted account chats. The default limit is 10; pass `limit=0` only when you intentionally want all account chats:
+
+```python
+latest_chats = om.chats.list()
+all_chats = om.chats.list(limit=0)
+```
+
+Create a non-persistent chat. This is the default and does not save the transcript to your OpenMates account:
+
+```python
+response = om.chats.send("Summarize this release note draft.")
+print(response.content)
+```
+
+Create a saved account chat explicitly:
+
+```python
+om.chats.send("Create a project kickoff checklist.", save_to_account=True)
+
+om.billing.overview()
+om.billing.invoices()
+om.docs.search("api keys")
+```
+
+## Errors
+
+The SDK raises `OpenMatesConfigError` for missing configuration and `OpenMatesApiError` for API responses such as expired keys, unapproved devices, missing scopes, or exceeded credit limits.
+
+Full source docs: `docs/user-guide/developers/sdk.md` in the OpenMates repository.
+
+## Publishing
+
+Maintainers publish this package through PyPI Trusted Publishing from GitHub
+Actions. See `docs/contributing/guides/publish-python-sdk.md` for first-time
+PyPI setup, versioning rules, and the automated `dev`/`main` release flow.

openmates-0.14.0a0/README.md

@@ -0,0 +1,71 @@
+# openmates
+
+Python SDK for OpenMates API-key access to app skills and encrypted chat workflows.
+
+## Install
+
+```bash
+pip install openmates
+```
+
+## API Key
+
+Create an API key in OpenMates under Settings > Developers > API Keys. The guided flow asks for scope, credit limit, and expiration before revealing the key once.
+
+Set the key in your environment:
+
+```bash
+export OPENMATES_API_KEY="sk-api-..."
+```
+
+New SDK devices are blocked until approved in Settings > Developers > Devices.
+
+## Usage
+
+```python
+from openmates import OpenMates
+
+om = OpenMates()  # reads OPENMATES_API_KEY
+
+result = om.apps.web.search({
+    "requests": [{"query": "OpenMates SDK examples"}],
+})
+```
+
+SDK methods authenticate lazily; there is no `connect()` call.
+
+List encrypted account chats. The default limit is 10; pass `limit=0` only when you intentionally want all account chats:
+
+```python
+latest_chats = om.chats.list()
+all_chats = om.chats.list(limit=0)
+```
+
+Create a non-persistent chat. This is the default and does not save the transcript to your OpenMates account:
+
+```python
+response = om.chats.send("Summarize this release note draft.")
+print(response.content)
+```
+
+Create a saved account chat explicitly:
+
+```python
+om.chats.send("Create a project kickoff checklist.", save_to_account=True)
+
+om.billing.overview()
+om.billing.invoices()
+om.docs.search("api keys")
+```
+
+## Errors
+
+The SDK raises `OpenMatesConfigError` for missing configuration and `OpenMatesApiError` for API responses such as expired keys, unapproved devices, missing scopes, or exceeded credit limits.
+
+Full source docs: `docs/user-guide/developers/sdk.md` in the OpenMates repository.
+
+## Publishing
+
+Maintainers publish this package through PyPI Trusted Publishing from GitHub
+Actions. See `docs/contributing/guides/publish-python-sdk.md` for first-time
+PyPI setup, versioning rules, and the automated `dev`/`main` release flow.

openmates-0.14.0a0/openmates/__init__.py

@@ -0,0 +1,11 @@
+"""OpenMates Python SDK public exports.
+
+Purpose: expose the ergonomic Python API-key SDK entrypoint.
+Architecture: thin package barrel over openmates.sdk.
+Security: API keys are passed through at request time and never persisted.
+Tests: packages/openmates-python/tests/test_sdk.py.
+"""
+
+from .sdk import OpenMates, OpenMatesApiError, OpenMatesConfigError
+
+__all__ = ["OpenMates", "OpenMatesApiError", "OpenMatesConfigError"]

openmates-0.14.0a0/openmates/generated/__init__.py

@@ -0,0 +1,7 @@
+"""Generated OpenMates Python SDK modules.
+
+Purpose: package generated native app-skill namespaces.
+Architecture: docs/specs/sdk-cli-parity-v1/spec.yml.
+Security: generated wrappers delegate to the API-key SDK client.
+Tests: packages/openmates-python/tests/test_sdk_generator.py.
+"""