ediarum.sdk
Version: 0.3.0
© 2026 by Berlin-Brandenburg Academy of Sciences and Humanities
Part of ediarum (https://www.ediarum.org, ediarum@bbaw.de)
Developed by TELOTA (https://www.bbaw.de/telota, telota@bbaw.de), a DH working group of the Berlin-Brandenburg Academy of Sciences and Humanities.
Developer of ediarum.sdk:
- Malte Vogl
Shared Python package for ediarum backend services (ediarum.index,
ediarum.id, ediarum.fileservice). It provides platform authentication,
a debounced file watcher and a client for the platform's project registry.
Requires Python 3.13 or later.
Modules
| Module | Contents |
|---|---|
ediarum_sdk.auth |
Caller identification for FastAPI apps: platform auth-verify client (platform_user, PlatformCallerDep, ProjectCallerDep, PlatformAdminDep) and hashed API keys (ApiKey, make_api_key_dependency). Both produce a Caller. |
ediarum_sdk.watch |
Watcher: debounced, per-project filesystem watcher that calls on_due(project, paths) once a project has been quiet for quiet_seconds. |
ediarum_sdk.projects |
ProjectsClient: thread-safe, caching client for the platform's project list (ProjectInfo). Serves the last cached list if the platform is unreachable. |
Configuration
| Variable | Used by | Purpose |
|---|---|---|
AUTH_VERIFY_URL |
auth.AuthConfig.from_env() |
Platform auth-verify endpoint |
AUTH_DEV_USER |
auth.AuthConfig.from_env() |
Treat every request as this admin user. Development only; mutually exclusive with AUTH_VERIFY_URL |
PLATFORM_PROJECTS_URL |
projects.ProjectsClient |
Platform project registry, …/api/auth/service/projects (can also be passed as url=) |
PLATFORM_SERVICE_TOKEN |
projects.ProjectsClient |
Service token for the registry, sent as Authorization: Bearer (can also be passed as token=) |
Usage
from pathlib import Path
from ediarum_sdk.watch import Watcher
def handle_changes(project: str, paths: set[str]) -> None:
...
Watcher({"demo": Path("/data/xml/demo")}, on_due=handle_changes).run_forever()
import httpx2 as httpx
from ediarum_sdk.projects import ProjectsClient
projects = ProjectsClient(httpx.Client())
info = projects.get("demo")
Notes
- The watcher is a supplementary trigger. File-change events can be lost; services should also run a periodic content-hash scan.
- The registry answers with
slug,name,repo_url,branchandindex_source_of_truth(xml/app: where ediarum.index takes the project's registers from).ProjectInfomapsnametolabel;sparse_pathis""(whole repository) unless a row sets it.
Installation
uv add ediarum-sdk
For development against unreleased changes, use a path dependency in
[tool.uv.sources].
Development
uv sync
uv run pytest
Release
A release is a tag vX.Y.Z that matches version in pyproject.toml; CI
publishes it to PyPI.
-
On
main, with a green pipeline:uv version --bump patch(orminor,major); set the same version in theVersion:line above and inCITATION.cff(withdate-released). Commit these four files. -
git tag -a v$(uv version --short) -m v$(uv version --short) && git push --follow-tags(--follow-tagspushes annotated tags only).scripts/release.sh patch|minor|majordoes steps 1 and 2: it refuses unless onmainwith a clean tree, level withorigin/mainand the tag free, and asks before committing and pushing. -
The tag pipeline runs the tests, then
publish: it refuses a tag that differs from the version, builds the package and uploads it withuv publish(the masked, protected CI/CD variableUV_PUBLISH_TOKEN). -
In the apps:
uv lock --upgrade-package ediarum-sdk(widen the version range inpyproject.tomlfor a new minor version).
Tags v* are protected (Settings → Repository → Protected tags): only
maintainers create releases, and protected variables such as
UV_PUBLISH_TOKEN are only available to protected refs.
License
MIT, see the file LICENSE.
Cite this software
If you use this software, please cite it using the metadata in the file
CITATION.cff (for more information about CFF see
https://citation-file-format.github.io/).
Metadata
Release files for ediarum-sdk 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ediarum_sdk-0.3.0.tar.gz | 10.4 kB | Without provenance | Details for ediarum_sdk-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ediarum_sdk-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for ediarum_sdk-0.3.0-py3-none-any.whl |
Total release size: 23.2 kB
Release files / ediarum_sdk-0.3.0.tar.gz
| Download URL | ediarum_sdk-0.3.0.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f55d2186179431226ef327d452ed5146d9c2e476eb2c69e1dd5cad750401f500
|
|
BLAKE2b-256 checksum How to use checksums |
125af18e22aa497232de829d028df96a6aca1c2837a3c3acfbcce5724c95e66f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / ediarum_sdk-0.3.0-py3-none-any.whl
| Download URL | ediarum_sdk-0.3.0-py3-none-any.whl |
|---|---|
| Size | 12.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
96b68e43bcbc50672f7eb2af414f14dc2914fd41894cd24f2f7e37f3a225196d
|
|
BLAKE2b-256 checksum How to use checksums |
cc63ed055a53c5abd164ec029658eb74194af3edac0da3acaf6f4d9ef942426a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for ediarum-sdk 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.