clinia-context-engine 0.8.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ .venv/
2
+ dist/
3
+ __pycache__/
4
+ .pytest_cache/
5
+ .ruff_cache/
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Clinia Health Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,132 @@
1
+ Metadata-Version: 2.5
2
+ Name: clinia-context-engine
3
+ Version: 0.8.0
4
+ Summary: Python client for the Clinia Context Engine API
5
+ Project-URL: Homepage, https://www.clinia.com
6
+ License-Expression: Apache-2.0
7
+ License-File: LICENSE
8
+ Requires-Python: >=3.10
9
+ Requires-Dist: httpx<1,>=0.27
10
+ Requires-Dist: pydantic<3,>=2.7
11
+ Description-Content-Type: text/markdown
12
+
13
+ # clinia-context-engine
14
+
15
+ Python client for the Clinia Context Engine API. A thin, typed wrapper over
16
+ [`httpx`](https://www.python-httpx.org/) with [Pydantic v2](https://docs.pydantic.dev/)
17
+ models generated from the OpenAPI contract — resource methods, parameters, and
18
+ response models are fully typed, in both sync and async flavors. Requires
19
+ Python 3.10+.
20
+
21
+ ## Install
22
+
23
+ ```sh
24
+ pip install clinia-context-engine
25
+ ```
26
+
27
+ ## Usage
28
+
29
+ Every Clinia workspace requires authentication. Create OAuth credentials in the
30
+ [Console](https://console.clinia.cloud) — scoped to your workspace, with **Read &
31
+ Write** if you intend to ingest data or create patients — then point `base_url`
32
+ at your workspace:
33
+
34
+ ```python
35
+ from clinia_context_engine import ClientCredentials, ContextEngineClient
36
+
37
+ with ContextEngineClient(
38
+ base_url="https://<workspace-id>.w.clinia.cloud",
39
+ auth=ClientCredentials(client_id="your-client-id", client_secret="your-client-secret"),
40
+ ) as client:
41
+ patients = client.patients.list_patients()
42
+ report = client.patients.get_resolution("patient-123", page=0, per_page=50)
43
+ ```
44
+
45
+ That is the whole configuration. The client resolves Clinia's authorization
46
+ server, acquires a bearer token, caches it, refreshes it before expiry, and
47
+ attaches `Authorization: Bearer <token>` to every request. Tokens last an hour;
48
+ you do not manage them.
49
+
50
+ Methods are grouped by resource (`client.patients`, `client.ingest`,
51
+ `client.sessions`, `client.vfs`, `client.graph`, `client.info`) and return
52
+ Pydantic models parsed from the response. Field names are `snake_case` in
53
+ Python and mapped to the API's wire names automatically.
54
+
55
+ Non-2xx responses raise `APIStatusError`, carrying the parsed error envelope:
56
+
57
+ ```python
58
+ from clinia_context_engine import APIStatusError
59
+
60
+ try:
61
+ client.patients.get_patient("missing")
62
+ except APIStatusError as err:
63
+ print(err.status_code, err.error.type if err.error else err.body)
64
+ ```
65
+
66
+ ### Async
67
+
68
+ `AsyncContextEngineClient` is the async twin — same resources, same signatures,
69
+ `await`ed:
70
+
71
+ ```python
72
+ from clinia_context_engine import AsyncContextEngineClient, ClientCredentials
73
+
74
+ async with AsyncContextEngineClient(base_url=base_url, auth=credentials) as client:
75
+ patients = await client.patients.list_patients()
76
+ ```
77
+
78
+ ### Without authentication
79
+
80
+ Omit `auth` entirely and the client sends no `Authorization` header. Useful
81
+ against a server that does not require one — a stub or recorded fixture in your
82
+ own tests. An `http://` base URL is fine there. Note this is about the _client_
83
+ sending no credentials: a Clinia workspace always requires them, so pointing an
84
+ unauthenticated client at one yields 401s on every request rather than a clear
85
+ startup failure.
86
+
87
+ ### Bring your own token
88
+
89
+ For a token you obtained elsewhere, a different grant, or a custom refresh
90
+ strategy, pass `auth` a callable instead of a config. It is called per request
91
+ and returns the token to attach:
92
+
93
+ ```python
94
+ client = ContextEngineClient(base_url=base_url, auth=lambda: token_store.valid_access_token())
95
+ ```
96
+
97
+ `ClientCredentialsTokenProvider` (and its async twin) is exactly such a
98
+ callable, so one cached provider can be shared across several clients.
99
+
100
+ ### Bring your own httpx client
101
+
102
+ Pass `http_client` an `httpx.Client` (or `httpx.AsyncClient`) you configured
103
+ yourself — proxies, event hooks, a `MockTransport` in tests. A provided client
104
+ is not closed by `close()`.
105
+
106
+ ## Options
107
+
108
+ | Option | Type | Description |
109
+ | ------------- | ------------------------------------------- | ----------------------------------------------------------------------------------- |
110
+ | `base_url` | `str` | Context Engine workspace base URL. Required. |
111
+ | `auth` | `ClientCredentials` or `() -> str` callable | OAuth2 client-credentials config (common case) **or** a per-request token callable. |
112
+ | `timeout` | `float` or `httpx.Timeout` | Request timeout. Defaults to 60 seconds. |
113
+ | `http_client` | `httpx.Client` / `httpx.AsyncClient` | Preconfigured transport; not closed by the client. |
114
+
115
+ ## Development
116
+
117
+ This package is generated from the Context Engine OpenAPI spec — the Pydantic
118
+ models by [datamodel-code-generator](https://github.com/koxudaxi/datamodel-code-generator),
119
+ the resource classes by the repository's generator. Regenerate with
120
+ `pnpm generate` from the repository root; do not edit `generated/` or
121
+ `resources/` by hand.
122
+
123
+ ```sh
124
+ uv sync --group dev
125
+ uv run --group dev pytest
126
+ uv run --group dev pyright
127
+ uv run --group dev ruff check src tests
128
+ ```
129
+
130
+ ## License
131
+
132
+ [Apache-2.0](LICENSE) © Clinia Health Inc.
@@ -0,0 +1,120 @@
1
+ # clinia-context-engine
2
+
3
+ Python client for the Clinia Context Engine API. A thin, typed wrapper over
4
+ [`httpx`](https://www.python-httpx.org/) with [Pydantic v2](https://docs.pydantic.dev/)
5
+ models generated from the OpenAPI contract — resource methods, parameters, and
6
+ response models are fully typed, in both sync and async flavors. Requires
7
+ Python 3.10+.
8
+
9
+ ## Install
10
+
11
+ ```sh
12
+ pip install clinia-context-engine
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ Every Clinia workspace requires authentication. Create OAuth credentials in the
18
+ [Console](https://console.clinia.cloud) — scoped to your workspace, with **Read &
19
+ Write** if you intend to ingest data or create patients — then point `base_url`
20
+ at your workspace:
21
+
22
+ ```python
23
+ from clinia_context_engine import ClientCredentials, ContextEngineClient
24
+
25
+ with ContextEngineClient(
26
+ base_url="https://<workspace-id>.w.clinia.cloud",
27
+ auth=ClientCredentials(client_id="your-client-id", client_secret="your-client-secret"),
28
+ ) as client:
29
+ patients = client.patients.list_patients()
30
+ report = client.patients.get_resolution("patient-123", page=0, per_page=50)
31
+ ```
32
+
33
+ That is the whole configuration. The client resolves Clinia's authorization
34
+ server, acquires a bearer token, caches it, refreshes it before expiry, and
35
+ attaches `Authorization: Bearer <token>` to every request. Tokens last an hour;
36
+ you do not manage them.
37
+
38
+ Methods are grouped by resource (`client.patients`, `client.ingest`,
39
+ `client.sessions`, `client.vfs`, `client.graph`, `client.info`) and return
40
+ Pydantic models parsed from the response. Field names are `snake_case` in
41
+ Python and mapped to the API's wire names automatically.
42
+
43
+ Non-2xx responses raise `APIStatusError`, carrying the parsed error envelope:
44
+
45
+ ```python
46
+ from clinia_context_engine import APIStatusError
47
+
48
+ try:
49
+ client.patients.get_patient("missing")
50
+ except APIStatusError as err:
51
+ print(err.status_code, err.error.type if err.error else err.body)
52
+ ```
53
+
54
+ ### Async
55
+
56
+ `AsyncContextEngineClient` is the async twin — same resources, same signatures,
57
+ `await`ed:
58
+
59
+ ```python
60
+ from clinia_context_engine import AsyncContextEngineClient, ClientCredentials
61
+
62
+ async with AsyncContextEngineClient(base_url=base_url, auth=credentials) as client:
63
+ patients = await client.patients.list_patients()
64
+ ```
65
+
66
+ ### Without authentication
67
+
68
+ Omit `auth` entirely and the client sends no `Authorization` header. Useful
69
+ against a server that does not require one — a stub or recorded fixture in your
70
+ own tests. An `http://` base URL is fine there. Note this is about the _client_
71
+ sending no credentials: a Clinia workspace always requires them, so pointing an
72
+ unauthenticated client at one yields 401s on every request rather than a clear
73
+ startup failure.
74
+
75
+ ### Bring your own token
76
+
77
+ For a token you obtained elsewhere, a different grant, or a custom refresh
78
+ strategy, pass `auth` a callable instead of a config. It is called per request
79
+ and returns the token to attach:
80
+
81
+ ```python
82
+ client = ContextEngineClient(base_url=base_url, auth=lambda: token_store.valid_access_token())
83
+ ```
84
+
85
+ `ClientCredentialsTokenProvider` (and its async twin) is exactly such a
86
+ callable, so one cached provider can be shared across several clients.
87
+
88
+ ### Bring your own httpx client
89
+
90
+ Pass `http_client` an `httpx.Client` (or `httpx.AsyncClient`) you configured
91
+ yourself — proxies, event hooks, a `MockTransport` in tests. A provided client
92
+ is not closed by `close()`.
93
+
94
+ ## Options
95
+
96
+ | Option | Type | Description |
97
+ | ------------- | ------------------------------------------- | ----------------------------------------------------------------------------------- |
98
+ | `base_url` | `str` | Context Engine workspace base URL. Required. |
99
+ | `auth` | `ClientCredentials` or `() -> str` callable | OAuth2 client-credentials config (common case) **or** a per-request token callable. |
100
+ | `timeout` | `float` or `httpx.Timeout` | Request timeout. Defaults to 60 seconds. |
101
+ | `http_client` | `httpx.Client` / `httpx.AsyncClient` | Preconfigured transport; not closed by the client. |
102
+
103
+ ## Development
104
+
105
+ This package is generated from the Context Engine OpenAPI spec — the Pydantic
106
+ models by [datamodel-code-generator](https://github.com/koxudaxi/datamodel-code-generator),
107
+ the resource classes by the repository's generator. Regenerate with
108
+ `pnpm generate` from the repository root; do not edit `generated/` or
109
+ `resources/` by hand.
110
+
111
+ ```sh
112
+ uv sync --group dev
113
+ uv run --group dev pytest
114
+ uv run --group dev pyright
115
+ uv run --group dev ruff check src tests
116
+ ```
117
+
118
+ ## License
119
+
120
+ [Apache-2.0](LICENSE) © Clinia Health Inc.
@@ -0,0 +1,54 @@
1
+ [project]
2
+ name = "clinia-context-engine"
3
+ version = "0.8.0"
4
+ description = "Python client for the Clinia Context Engine API"
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ requires-python = ">=3.10"
8
+ dependencies = [
9
+ "httpx>=0.27,<1",
10
+ "pydantic>=2.7,<3",
11
+ ]
12
+
13
+ [project.urls]
14
+ Homepage = "https://www.clinia.com"
15
+
16
+ [dependency-groups]
17
+ dev = [
18
+ "pytest>=8",
19
+ "pytest-asyncio>=0.24",
20
+ "respx>=0.22",
21
+ "pyright>=1.1.390",
22
+ "ruff>=0.8",
23
+ "datamodel-code-generator>=0.78",
24
+ ]
25
+
26
+ [build-system]
27
+ requires = ["hatchling"]
28
+ build-backend = "hatchling.build"
29
+
30
+ [tool.hatch.build.targets.wheel]
31
+ packages = ["src/clinia_context_engine"]
32
+
33
+ # The sdist ships publicly: only the package itself, never the monorepo
34
+ # scaffolding around it (package.json shim, generator scripts, tests).
35
+ [tool.hatch.build.targets.sdist]
36
+ include = ["src", "README.md", "LICENSE"]
37
+
38
+ [tool.ruff]
39
+ line-length = 100
40
+ src = ["src", "tests"]
41
+
42
+ [tool.ruff.lint]
43
+ select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
44
+ # Generated models keep spec-ordered fields; import sorting still applies.
45
+ # RUF001-003: descriptions are the spec's prose, typography included.
46
+ per-file-ignores = { "src/clinia_context_engine/generated/*" = ["E501", "RUF001", "RUF002", "RUF003"] }
47
+
48
+ [tool.pyright]
49
+ include = ["src", "tests", "examples"]
50
+ typeCheckingMode = "strict"
51
+
52
+ [tool.pytest.ini_options]
53
+ testpaths = ["tests"]
54
+ asyncio_mode = "auto"
@@ -0,0 +1,28 @@
1
+ from . import resources as resources
2
+ from ._auth import (
3
+ AsyncClientCredentialsTokenProvider,
4
+ ClientCredentials,
5
+ ClientCredentialsTokenProvider,
6
+ )
7
+ from ._errors import APIConnectionError, APIStatusError, APITimeoutError, ContextEngineError
8
+ from ._http import AsyncHttpClient, AsyncTokenProvider, HttpClient, TokenProvider
9
+ from .client import AsyncContextEngineClient, ContextEngineClient
10
+ from .generated import models as models
11
+
12
+ __all__ = [
13
+ "APIConnectionError",
14
+ "APIStatusError",
15
+ "APITimeoutError",
16
+ "AsyncClientCredentialsTokenProvider",
17
+ "AsyncContextEngineClient",
18
+ "AsyncHttpClient",
19
+ "AsyncTokenProvider",
20
+ "ClientCredentials",
21
+ "ClientCredentialsTokenProvider",
22
+ "ContextEngineClient",
23
+ "ContextEngineError",
24
+ "HttpClient",
25
+ "TokenProvider",
26
+ "models",
27
+ "resources",
28
+ ]