CCCHH/dooris
1
1
Fork 0
Code Issues 1 Pull requests 1 Releases Packages 1 Activity Actions

improve project structure for api

Browse source
This commit is contained in:
lilly 2026-05-03 20:57:13 +02:00
commit 7fa9867a38
Signed by: lilly
SSH key fingerprint: SHA256:y9T5GFw2A20WVklhetIxG1+kcg/Ce0shnQmbu1LQ37g
7 changed files with 42 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -9,3 +9,13 @@ Project structure:
├── api # Python application interacting with HomeMatic and providing the API.
└── app # Web UI
```
## API Development
Most things should automatically be set up with the included [direnv script](./.envrc.dist) but if you don't use that, take the following steps:
1. Go to the api/ directory
2. Run `uv venv` to create a python virtual environment
3. Install all dependencies of the dooris project into that virtual environment with `uv sync`
4. Run a development server `uv run uvicorn dooris_api:app --reload`