From a287b22bf7649c0bd52b4cf8bd73c6f988c513c4 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 28 Sep 2026 10:03:13 +0000 Subject: [PATCH] docs(tooling): add Libraries & SDKs section and move oehrpy there As agreed on the openEHR Discourse thread, add a dedicated 'Libraries & SDKs' nav section under Tooling and move the oehrpy entry out of Developer Tooling into it. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_011KihmGW32CEUTX9EZ6PD3F --- docs/tooling/developer-tooling.md | 17 ----------------- docs/tooling/libraries-and-sdks.md | 20 ++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 21 insertions(+), 17 deletions(-) create mode 100644 docs/tooling/libraries-and-sdks.md diff --git a/docs/tooling/developer-tooling.md b/docs/tooling/developer-tooling.md index dabbcb5..be69c6b 100644 --- a/docs/tooling/developer-tooling.md +++ b/docs/tooling/developer-tooling.md @@ -30,23 +30,6 @@ **What it is:** A Java SDK for working with openEHR artefacts: parsing and serialising compositions, working with templates, and building AQL queries. EHRbase uses it internally. -## oehrpy - -| | | -| --- | --- | -| Status | Active (alpha) | -| Cost | Free (Apache 2.0) | -| Open source | Yes | -| Language | Python | -| Owner and developer | [platzhersh](https://github.com/platzhersh) | -| Available from | [PyPI](https://pypi.org/project/oehrpy/) (`pip install oehrpy`) | -| Source | [github.com/platzhersh/oehrpy](https://github.com/platzhersh/oehrpy) | -| Documentation | [oehrpy.dev](https://oehrpy.dev/) | - -**What it is:** A Python SDK for openEHR. It provides Pydantic models for the Reference Model 1.1.0, template-specific composition builders, FLAT and canonical JSON serialisation, a fluent AQL builder, an OPT parser and validator, and an async REST client for EHRbase. - -**Who should use it:** Python developers building applications, data pipelines, or scripts against an openEHR CDR who want typed RM objects and IDE autocomplete instead of hand-assembling composition JSON. Its REST client and FLAT format support currently target EHRbase 2.26 and later. - ## Archie | | | diff --git a/docs/tooling/libraries-and-sdks.md b/docs/tooling/libraries-and-sdks.md new file mode 100644 index 0000000..f4410a2 --- /dev/null +++ b/docs/tooling/libraries-and-sdks.md @@ -0,0 +1,20 @@ +# Libraries & SDKs + +Libraries and software development kits (SDKs) that developers embed in their own applications to work with openEHR artefacts, data, and APIs. + +## oehrpy + +| | | +| --- | --- | +| Status | Active (alpha) | +| Cost | Free (Apache 2.0) | +| Open source | Yes | +| Language | Python | +| Owner and developer | [platzhersh](https://github.com/platzhersh) | +| Available from | [PyPI](https://pypi.org/project/oehrpy/) (`pip install oehrpy`) | +| Source | [github.com/platzhersh/oehrpy](https://github.com/platzhersh/oehrpy) | +| Documentation | [oehrpy.dev](https://oehrpy.dev/) | + +**What it is:** A Python SDK for openEHR. It provides Pydantic models for the Reference Model 1.1.0, template-specific composition builders, FLAT and canonical JSON serialisation, a fluent AQL builder, an OPT parser and validator, and an async REST client for EHRbase. + +**Who should use it:** Python developers building applications, data pipelines, or scripts against an openEHR CDR who want typed RM objects and IDE autocomplete instead of hand-assembling composition JSON. Its REST client and FLAT format support currently target EHRbase 2.26 and later. diff --git a/mkdocs.yml b/mkdocs.yml index 3fb4fad..e0f4a4b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -38,6 +38,7 @@ nav: - Clinical Data Repositories: tooling/clinical-data-repositories.md - Knowledge Management: tooling/knowledge-management.md - Developer Tooling: tooling/developer-tooling.md + - Libraries & SDKs: tooling/libraries-and-sdks.md - Query Tools: tooling/query-tools.md - Deprecated Tools: tooling/deprecated-tools.md - Comparison Table: tooling/comparison-table.md