EndoReg-DB
EndoReg-DB is a reusable Django application for clinical and research data. It provides shared data models, terminology, report and video processing, and authenticated APIs for ingesting and reading clinical media.
See the project overview for capabilities, deployment roles, and the repository map.
Find your way
- New contributor: start with the setup guide and documentation index.
- Developer: use the devenv workflow and read the model layer map.
- Deployment operator: see deployment and operations and configuration.
- API or integration author: see the API and security references.
- Looking for project status: use the feature tracker.
- Trying Django shell examples: see developer examples.
- Looking for recovery guidance: see database backup and recovery.
Quick start
This checkout uses Python 3.12 and uv, configured through devenv.nix.
From the repository root:
direnv allow
devenv tasks run agent:sync
uv run python manage.py migrate
uv run python manage.py setup_endoreg_db
setup_endoreg_db loads base database data and runs the configured setup
checks. For environment variables, deployment roles, protected storage, and
ingress behavior, see the configuration guide.
Use load_base_db_data when you need to load
only the base seed data.
Development
Run the repository's documented fast test lane with:
devenv tasks run test:fast
See AGENTS.md for contribution rules, required checks, and data handling constraints. The documentation index is the main catalog for maintained guides, contracts, and runbooks.
Important boundaries
- Ingest can enter through a trusted local watcher or authenticated API; both use the shared processing workflow. See the hub ingest operations guide.
- Applications should use center-scoped media APIs instead of accessing media directories directly. See API, access, and security.
- Deployments must provide the protected storage boundary required by their storage profile. See configuration and the video storage contract.
- Feature scope and readiness evidence belong to
feature-tracking/, not in this overview.
Repository map
| Path | What it contains |
|---|---|
endoreg_db/ |
Django application, services, models, management commands, and seed data |
docs/ |
Maintained architecture contracts, API references, guides, and runbooks |
setup/ |
Configuration, privacy, and AI setup guides |
feature-tracking/ |
Feature definitions, acceptance criteria, and readiness evidence |
tests/ |
Automated tests grouped by application area |
scripts/ |
Repository tooling and checks; GPU diagnostics in diagnostics/ |
workflow/ |
Reusable workflow profiles |
Further information
Metadata
Release files for endoreg-db 1.5.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| endoreg_db-1.5.5.tar.gz | 1.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| endoreg_db-1.5.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.12 | CPython 3.12 | Linux glibc 2.17+ x86-64 | Details |
Total release size: 4.0 MB
Release files / endoreg_db-1.5.5.tar.gz
| Download URL | endoreg_db-1.5.5.tar.gz |
|---|---|
| Size | 1.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eb5ddbb563b84a15634deeb45b56eee6b8bdbedbcee1d62a4701122622998c43
|
|
BLAKE2b-256 checksum How to use checksums |
3bd21cddd748c5cf4686d9621c022323bf4980ab857eba113db295abf789e3a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / endoreg_db-1.5.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | endoreg_db-1.5.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 2.5 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
2d4153f84c8607e6a778cba9fcffa2df51ceebf034e9968d465ccc1f08a3bdb2
|
|
BLAKE2b-256 checksum How to use checksums |
1a783a7462ba2d575f6a249a9562c0b09825d3dcdea428b049469d4c5b6b14d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
