mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-12-14 15:56:17 +00:00
2f5f844018
* Migrate from Flask to FastAPI
* FastAPI migration:
- Use pydantic model classes as input parameters to the
data/calculation classes.
- Interface field names changed to constructor parameter names (for
simplicity only during transition, should be updated in a followup
PR).
- Add basic interface requirements (e.g. some values > 0, etc.).
* Update tests for new data format.
* Python requirement down to 3.9 (TypeGuard no longer needed)
* Makefile: Add helpful targets (e.g. development server with reload)
* Move API doc from README to pydantic model classes (swagger)
* Link to swagger.io with own openapi.yml.
* Commit openapi.json and check with pytest for changes so the
documentation is always up-to-date.
* Streamline docker
* FastAPI: Run startup action on dev server
* Fix config for /strompreis, endpoint still broken however.
* test_openapi: Compare against docs/.../openapi.json
* Move fastapi to server/ submodule
* See #187 for new repository structure.
26 lines
368 B
Markdown
26 lines
368 B
Markdown
% SPDX-License-Identifier: Apache-2.0
|
|
|
|
```{image} _static/logo.png
|
|
|
|
```
|
|
|
|
# Akkudoktor EOS documentation
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
:caption: 'Contents:'
|
|
|
|
welcome.md
|
|
akkudoktoreos/about.md
|
|
develop/getting_started.md
|
|
develop/CONTRIBUTING.md
|
|
akkudoktoreos/serverapi.rst
|
|
akkudoktoreos/api.rst
|
|
```
|
|
|
|
# Indices and tables
|
|
|
|
- {ref}`genindex`
|
|
- {ref}`modindex`
|
|
- {ref}`search`
|