rosenbound 0.1.0__tar.gz

rosenbound-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+# Build + packaging artifacts
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Bytecode + caches
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# The repo-root code/.gitignore ignores all *.csv. Re-include the committed
+# test fixture (leading slash anchors the negation to this directory so it
+# does not over-match nested paths). Parent dirs are not excluded, so the
+# re-inclusion takes effect.
+!/tests/fixtures/cohort_5k_pv.csv

rosenbound-0.1.0/LICENSE

@@ -0,0 +1,204 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+Copyright 2026 Harsh Singh / Rosenbound

rosenbound-0.1.0/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: rosenbound
+Version: 0.1.0
+Summary: Official Python SDK for the Rosenbound clinical-AI platform
+Project-URL: Homepage, https://rosenbound.com
+Project-URL: Documentation, https://rosenbound.com/docs/sdk/python
+Author-email: Harsh Singh <harshrajput618@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: causal-inference,clinical-ai,pharmacovigilance,rosenbound,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Healthcare Industry
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.26
+Requires-Dist: pydantic>=2.5
+Requires-Dist: typing-extensions>=4.8
+Provides-Extra: dev
+Requires-Dist: mypy>=1.9; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# rosenbound
+
+Official Python SDK for the **Rosenbound** clinical-AI platform — a causal,
+auditable clinical decision-support platform for structured medical and
+pharmacological data.
+
+The SDK is a typed, Pydantic-based wrapper over the platform's REST API
+(platform API **v1**). It is sync-first; an asynchronous client is reserved for
+a future release.
+
+> **Status — v0.1.0 (alpha).** This release implements the **Cohorts**
+> (list / get / create), **Studies** (list / get / create / run / results), and
+> **Certificates** (reproducibility certificate + methodology PDF) surfaces —
+> the full cohort → study → run → result → certificate loop. An asynchronous
+> client, SSO auth, certificate-chain `verify()`, and per-feature resources
+> (MedDRA, E2B, drug-coder, …) are reserved for a future release.
+
+---
+
+## Installation
+
+```bash
+pip install rosenbound
+```
+
+Requires Python ≥ 3.10. Runtime dependencies: `httpx`, `pydantic` (v2),
+`typing-extensions`.
+
+During pre-release the package installs from a local checkout:
+
+```bash
+cd code/sdk/python
+pip install -e ".[dev]"
+```
+
+## Authentication
+
+The SDK authenticates with a platform **API token**, sent on every request as
+`Authorization: Bearer <token>`. Tokens are issued from the in-product API-key
+management surface (which requires an admin role). The token is opaque to the
+SDK; the platform validates it and resolves your tenant + role from it.
+
+```python
+from rosenbound import Client
+
+client = Client(api_key="rk_your_token_here")
+```
+
+By default the client talks to `https://api.rosenbound.com`. Point it elsewhere
+(e.g. a staging host) with `base_url`:
+
+```python
+client = Client(api_key="rk_...", base_url="https://staging.api.rosenbound.com")
+```
+
+## Quick start — cohorts
+
+```python
+from rosenbound import Client
+
+with Client(api_key="rk_...") as client:
+    # Create a cohort from a CSV file plus a cohort-definition DSL.
+    cohort = client.cohorts.create(
+        name="metformin_t2dm_2026",
+        archetype="treatment_policy",
+        dsl_yaml="path/to/definition.yaml",   # YAML text or a Path to a file
+        csv_path="my_cohort.csv",
+    )
+    print(cohort.id, cohort.status)
+
+    # List cohorts (paginated, filterable by archetype + name search).
+    page = client.cohorts.list(archetype="treatment_policy", page=1, page_size=50)
+    print(f"{len(page.items)} of {page.total} cohorts")
+    for c in page.items:
+        print(c.id, c.name, c.archetype)
+
+    # Fetch one cohort by id.
+    detail = client.cohorts.get(cohort.id)
+    print(detail.cohort_def_hash, detail.data_hash)
+```
+
+### Cohort archetypes
+
+`archetype` is one of:
+
+| value | meaning |
+|---|---|
+| `pv` | pharmacovigilance pentagon cohort |
+| `longitudinal` | repeated-measures / longitudinal cohort |
+| `treatment_policy` | treatment-policy (A-vs-B) cohort |
+| `time_to_event` | survival / time-to-event cohort |
+
+The `dsl_yaml` cohort definition must validate against the chosen archetype,
+and every column it references must exist in the uploaded CSV header — the
+platform rejects a mismatch with a `ValidationError` at upload time.
+
+## Studies
+
+A study runs a causal protocol against a cohort and produces a 5-method
+(Pentagon) estimate set. The workflow is **create → run → fetch results**:
+
+```python
+with Client(api_key="rk_...") as client:
+    study = client.studies.create(
+        cohort_id=cohort.id,
+        protocol_id="pv_pentagon",
+        estimator_selection={},          # per-protocol config; {} = protocol defaults
+    )
+    print(study.id, study.status)        # -> "draft"
+
+    # run() executes synchronously: it returns once the Pentagon run reaches a
+    # terminal state, so the returned study is normally status="complete".
+    completed = client.studies.run(study.id, seed=17)   # seed pins reproducibility
+    print(completed.status)              # -> "complete"
+
+    result = client.studies.get_results(study.id)
+    print(result.pentagon_result_payload)        # the full 5-method estimate set
+
+    # List + filter (single status value, optional cohort filter, paginated).
+    page = client.studies.list(cohort_id=cohort.id, status="complete")
+    print(f"{len(page.items)} of {page.total} studies")
+```
+
+`protocol_id` is one of:
+
+| value | meaning |
+|---|---|
+| `pv_pentagon` | pharmacovigilance 5-method Pentagon |
+| `cr_longitudinal` | clinical-research longitudinal protocol |
+| `cr_treatment_policy` | treatment-policy (A-vs-B) protocol |
+| `cr_tte` | time-to-event / survival protocol |
+
+`run()` is synchronous today. If a run is already in progress it raises
+`ConflictError` (409); a server-side run failure raises `ServerError` (500).
+When the platform later adds an asynchronous job model, a blocking
+`wait_for_completion` poller will land alongside the async client (v0.2).
+
+## Certificates
+
+Every completed run mints a **reproducibility certificate** — the hashes and
+environment pins an external auditor re-derives the result from. The
+certificate is embedded in the study response; `certificates.get()` surfaces it:
+
+```python
+with Client(api_key="rk_...") as client:
+    cert = client.certificates.get(study.id)
+    print(cert.code_version)        # the code version that produced the result
+    print(cert.cohort_def_yaml_hash, cert.cohort_data_hash)
+    print(cert.library_versions)    # {package: version} pin map
+    print(cert.generated_at)
+
+    # Download the human-readable methodology PDF.
+    client.certificates.download_pdf(study.id, output_path="methodology.pdf")
+```
+
+| field | meaning |
+|---|---|
+| `cohort_def_yaml_hash` | SHA-256 of the cohort-definition YAML |
+| `cohort_data_hash` | SHA-256 of the input cohort data |
+| `code_version` | resolved code version (git SHA) that produced the result |
+| `library_versions` | `{package: version}` environment pin map |
+| `generated_at` | server-side timestamp the certificate was minted |
+
+`certificates.get()` raises `NotFoundError` if the study has no completed run
+yet. `download_pdf()` raises `ServerError` if the methodology PDF has not been
+materialized for the latest run (the platform returns 503 until the generator
+has produced the artifact). Re-validating the certificate chain against the
+platform's authoritative ledger — `certificates.verify()` — is a v0.2 stub that
+currently raises `NotImplementedError`.
+
+## End-to-end example
+
+The full loop in one block — upload a cohort, define and run a study, read the
+result, and fetch its reproducibility certificate:
+
+```python
+from rosenbound import Client
+
+with Client(api_key="rk_...") as client:
+    cohort = client.cohorts.create(
+        name="metformin_t2dm_2026",
+        archetype="treatment_policy",
+        dsl_yaml="definition.yaml",
+        csv_path="my_cohort.csv",
+    )
+    study = client.studies.create(
+        cohort_id=cohort.id,
+        protocol_id="pv_pentagon",
+    )
+    client.studies.run(study.id, seed=17)
+    result = client.studies.get_results(study.id)
+    cert = client.certificates.get(study.id)
+
+    print("estimates:", result.pentagon_result_payload)
+    print("reproducible under code version:", cert.code_version)
+```
+
+## Error handling
+
+Every SDK error derives from `RosenboundError`. The HTTP layer maps response
+status codes to specific subclasses:
+
+```python
+from rosenbound import (
+    Client,
+    AuthenticationError,  # 401 — invalid / missing API key
+    NotFoundError,        # 404 — absent, or not visible to your tenant
+    ValidationError,      # 422 — payload rejected (carries .errors)
+    ConflictError,        # 409 — state conflict (e.g. study already running)
+    RateLimitError,       # 429 — rate limit (carries .retry_after_seconds)
+    ServerError,          # 5xx — platform fault, after retries are exhausted
+    RosenboundError,      # base class — catch-all
+)
+
+with Client(api_key="rk_...") as client:
+    try:
+        client.cohorts.create(
+            name="bad",
+            archetype="pv",
+            dsl_yaml=open("definition.yaml").read(),
+            csv_path="cohort.csv",
+        )
+    except ValidationError as exc:
+        for err in exc.errors:        # the platform's structured error body
+            print(err)
+    except RateLimitError as exc:
+        print("retry after", exc.retry_after_seconds, "s")
+```
+
+A 404 means "not found *for you*" — the platform returns 404 (never 403) for
+cross-tenant reads so resource existence never leaks across tenants.
+
+## Retries and timeouts
+
+The client retries transient failures (HTTP **429** and **5xx**) up to
+`max_retries` times with deterministic exponential backoff
+(`0.5 * 2 ** attempt` seconds). A `429` carrying a numeric `Retry-After` header
+honors that value instead. Non-retryable errors (4xx other than 429) raise
+immediately.
+
+```python
+client = Client(
+    api_key="rk_...",
+    timeout=30.0,      # per-request timeout, seconds (default 30)
+    max_retries=3,     # additional attempts on 429 / 5xx (default 3)
+)
+```
+
+Network-layer failures (connection refused, DNS, read timeout) propagate as the
+underlying `httpx` transport exceptions and are not wrapped.
+
+## Resource management
+
+`Client` owns a connection pool. Use it as a context manager, or call
+`close()` explicitly:
+
+```python
+with Client(api_key="rk_...") as client:
+    ...  # pool is released on exit
+
+# or
+client = Client(api_key="rk_...")
+try:
+    ...
+finally:
+    client.close()
+```
+
+A single client is safe for serial use from one thread; construct one client
+per thread for concurrent use.
+
+## Compatibility
+
+- Python: ≥ 3.10
+- Platform API: v1
+- Concurrency: synchronous client only (async reserved for v0.2)
+- SDK version: see `rosenbound.__version__`
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).
+
+## Contact
+
+Issues and questions: the Rosenbound platform team.