realforce-api-client 0.0.26__tar.gz

realforce_api_client-0.0.26/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.3
+Name: realforce-api-client
+Version: 0.0.26
+Summary: Python client SDK for the Realforce API
+Author: Realforce
+License-Expression: MIT
+Keywords: api,client,realforce,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.9
+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
+Requires-Python: >=3.9
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<0.29.0,>=0.23.0
+Requires-Dist: python-dateutil<3,>=2.8.0
+Description-Content-Type: text/markdown
+
+# Realforce API - Python SDK
+
+Python client SDK for the Realforce API.
+
+**Version:** 0.0.26
+
+## Installation
+
+```bash
+pip install realforce-api-client
+```
+
+## Authentication
+
+Use a Realforce **Personal Access Token (PAT)**. Generate one in the Realforce dashboard. Send it as a Bearer token
+in the `Authorization` header.
+
+```python
+from realforce_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://api.realforce.com",
+    token="rfp_xxxxxxxxxxxxxxxx",
+)
+```
+
+## Workspace ID
+
+Most endpoints are scoped to a workspace. The generated client surfaces this as
+an `x_workspace_id` parameter (string GUID) on each method — pass the workspace
+your token has access to on every call:
+
+```python
+workspace_id = "00000000-0000-0000-0000-000000000000"
+agent = get_agent.sync(client=client, agent_id=agent_id, x_workspace_id=workspace_id)
+```
+
+## Quick Start
+
+```python
+from realforce_api_client import AuthenticatedClient
+from realforce_api_client.api.agents import query_agents
+
+client = AuthenticatedClient(
+    base_url="https://api.realforce.com",
+    token="rfp_xxxxxxxxxxxxxxxx",
+)
+
+workspace_id = "..."
+agents = query_agents.sync(client=client, x_workspace_id=workspace_id)
+```
+
+## Async Usage
+
+Every endpoint exposes both `.sync()` and `.asyncio()` variants:
+
+```python
+import asyncio
+from realforce_api_client import AuthenticatedClient
+from realforce_api_client.api.agents import get_agent
+
+client = AuthenticatedClient(
+    base_url="https://api.realforce.com",
+    token="rfp_xxxxxxxxxxxxxxxx",
+)
+
+async def main():
+    agent = await get_agent.asyncio(client=client, agent_id=agent_id, x_workspace_id=workspace_id)
+
+asyncio.run(main())
+```
+
+## Error Handling
+
+By default the client raises `httpx.HTTPStatusError` for non-2xx responses. Use
+the `_detailed` endpoint variants when you need to inspect the status code and
+parsed body without raising:
+
+```python
+from realforce_api_client.api.agents import get_agent
+
+response = get_agent.sync_detailed(client=client, agent_id=agent_id, x_workspace_id=workspace_id)
+if response.status_code == 200:
+    agent = response.parsed
+else:
+    print(f"HTTP {response.status_code}: {response.content!r}")
+```
+
+## Custom httpx Client
+
+`AuthenticatedClient` wraps an `httpx.Client`. Pass `httpx_args` to configure
+timeouts, retries, proxies, etc.:
+
+```python
+from realforce_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://api.realforce.com",
+    token="rfp_xxxxxxxxxxxxxxxx",
+    httpx_args={"timeout": 30.0},
+)
+```
+
+## Requirements
+
+- Python 3.9+
+- httpx >=0.23.0, <0.29.0
+
+## Support
+
+- Please contact the Realforce support team.

realforce_api_client-0.0.26/README.md

@@ -0,0 +1,111 @@
+# Realforce API - Python SDK
+
+Python client SDK for the Realforce API.
+
+**Version:** 0.0.26
+
+## Installation
+
+```bash
+pip install realforce-api-client
+```
+
+## Authentication
+
+Use a Realforce **Personal Access Token (PAT)**. Generate one in the Realforce dashboard. Send it as a Bearer token
+in the `Authorization` header.
+
+```python
+from realforce_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://api.realforce.com",
+    token="rfp_xxxxxxxxxxxxxxxx",
+)
+```
+
+## Workspace ID
+
+Most endpoints are scoped to a workspace. The generated client surfaces this as
+an `x_workspace_id` parameter (string GUID) on each method — pass the workspace
+your token has access to on every call:
+
+```python
+workspace_id = "00000000-0000-0000-0000-000000000000"
+agent = get_agent.sync(client=client, agent_id=agent_id, x_workspace_id=workspace_id)
+```
+
+## Quick Start
+
+```python
+from realforce_api_client import AuthenticatedClient
+from realforce_api_client.api.agents import query_agents
+
+client = AuthenticatedClient(
+    base_url="https://api.realforce.com",
+    token="rfp_xxxxxxxxxxxxxxxx",
+)
+
+workspace_id = "..."
+agents = query_agents.sync(client=client, x_workspace_id=workspace_id)
+```
+
+## Async Usage
+
+Every endpoint exposes both `.sync()` and `.asyncio()` variants:
+
+```python
+import asyncio
+from realforce_api_client import AuthenticatedClient
+from realforce_api_client.api.agents import get_agent
+
+client = AuthenticatedClient(
+    base_url="https://api.realforce.com",
+    token="rfp_xxxxxxxxxxxxxxxx",
+)
+
+async def main():
+    agent = await get_agent.asyncio(client=client, agent_id=agent_id, x_workspace_id=workspace_id)
+
+asyncio.run(main())
+```
+
+## Error Handling
+
+By default the client raises `httpx.HTTPStatusError` for non-2xx responses. Use
+the `_detailed` endpoint variants when you need to inspect the status code and
+parsed body without raising:
+
+```python
+from realforce_api_client.api.agents import get_agent
+
+response = get_agent.sync_detailed(client=client, agent_id=agent_id, x_workspace_id=workspace_id)
+if response.status_code == 200:
+    agent = response.parsed
+else:
+    print(f"HTTP {response.status_code}: {response.content!r}")
+```
+
+## Custom httpx Client
+
+`AuthenticatedClient` wraps an `httpx.Client`. Pass `httpx_args` to configure
+timeouts, retries, proxies, etc.:
+
+```python
+from realforce_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://api.realforce.com",
+    token="rfp_xxxxxxxxxxxxxxxx",
+    httpx_args={"timeout": 30.0},
+)
+```
+
+## Requirements
+
+- Python 3.9+
+- httpx >=0.23.0, <0.29.0
+
+## Support
+
+- Please contact the Realforce support team.