roamhq 0.1.0__tar.gz

roamhq-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wonder Inventions
+
+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 WITHOUT LIMITATION 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.

roamhq-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: roamhq
+Version: 0.1.0
+Summary: Official Python SDK for the Roam API
+Author-email: Wonder Inventions <developer@ro.am>
+License: MIT
+Project-URL: Homepage, https://developer.ro.am/docs/guides/sdks
+Project-URL: Repository, https://github.com/WonderInventions/roam-sdk-python
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.21.2
+Requires-Dist: pydantic>=1.9.2
+Requires-Dist: pydantic-core>=2.18.2
+Requires-Dist: typing_extensions>=4.0.0
+Dynamic: license-file
+
+# roamhq
+
+Official Python SDK for the [Roam API](https://developer.ro.am).
+
+```bash
+pip install roamhq
+```
+
+Requires **Python 3.10+**.
+
+```python
+import os
+from roamhq import RoamClient
+
+client = RoamClient(token=os.environ["ROAM_TOKEN"])
+
+result = client.chat.post(
+    group_id="88bebce7-6cbb-4666-96f9-5c02d73e6661",
+    text="Build completed successfully!",
+)
+```
+
+Full usage — pagination, retries, error handling, version pinning — is in the
+[SDK guide](https://developer.ro.am/docs/guides/sdks). The
+[API reference](https://developer.ro.am/docs/api/api) documents every endpoint.
+
+## Verifying webhooks
+
+```python
+from roamhq.webhooks import verify_webhook
+
+event = verify_webhook(body, request.headers, os.environ["ROAM_WEBHOOK_SECRET"])
+```
+
+`body` must be the **raw request bytes**. Treat any exception as a `401`. Pass
+the signing secret exactly as Roam issued it, `whsec_` prefix included.
+
+This is the one part of the SDK that is hand-written rather than generated. See
+[`src/roamhq/webhooks.py`](src/roamhq/webhooks.py) for why.
+
+## This repository is mostly generated
+
+The client and types are generated from the Roam OpenAPI specification by
+[Fern](https://buildwithfern.com). **Do not edit them by hand** — the next
+regeneration will overwrite them.
+
+A change to the spec opens or updates a single long-lived pull request here
+titled "Regenerate SDK from OpenAPI spec". A human reviews the diff, picks the
+semantic-version bump in `pyproject.toml`, and merges. Merging does not
+publish to PyPI.
+
+Everything listed in [`.fernignore`](.fernignore) is hand-maintained.

roamhq-0.1.0/README.md

@@ -0,0 +1,52 @@
+# roamhq
+
+Official Python SDK for the [Roam API](https://developer.ro.am).
+
+```bash
+pip install roamhq
+```
+
+Requires **Python 3.10+**.
+
+```python
+import os
+from roamhq import RoamClient
+
+client = RoamClient(token=os.environ["ROAM_TOKEN"])
+
+result = client.chat.post(
+    group_id="88bebce7-6cbb-4666-96f9-5c02d73e6661",
+    text="Build completed successfully!",
+)
+```
+
+Full usage — pagination, retries, error handling, version pinning — is in the
+[SDK guide](https://developer.ro.am/docs/guides/sdks). The
+[API reference](https://developer.ro.am/docs/api/api) documents every endpoint.
+
+## Verifying webhooks
+
+```python
+from roamhq.webhooks import verify_webhook
+
+event = verify_webhook(body, request.headers, os.environ["ROAM_WEBHOOK_SECRET"])
+```
+
+`body` must be the **raw request bytes**. Treat any exception as a `401`. Pass
+the signing secret exactly as Roam issued it, `whsec_` prefix included.
+
+This is the one part of the SDK that is hand-written rather than generated. See
+[`src/roamhq/webhooks.py`](src/roamhq/webhooks.py) for why.
+
+## This repository is mostly generated
+
+The client and types are generated from the Roam OpenAPI specification by
+[Fern](https://buildwithfern.com). **Do not edit them by hand** — the next
+regeneration will overwrite them.
+
+A change to the spec opens or updates a single long-lived pull request here
+titled "Regenerate SDK from OpenAPI spec". A human reviews the diff, picks the
+semantic-version bump in `pyproject.toml`, and merges. Merging does not
+publish to PyPI.
+
+Everything listed in [`.fernignore`](.fernignore) is hand-maintained.

roamhq-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "roamhq"
+version = "0.1.0"
+description = "Official Python SDK for the Roam API"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+authors = [{ name = "Wonder Inventions", email = "developer@ro.am" }]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "httpx>=0.21.2",
+    "pydantic>=1.9.2",
+    "pydantic-core>=2.18.2",
+    "typing_extensions>=4.0.0",
+]
+
+[project.urls]
+Homepage = "https://developer.ro.am/docs/guides/sdks"
+Repository = "https://github.com/WonderInventions/roam-sdk-python"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"*" = ["py.typed"]

roamhq-0.1.0/setup.cfg

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