📝 — Doc: add Alembic to the projects we use

This commit is contained in:
Luc Didry 2024-02-28 14:19:46 +01:00
parent e5bdee6cb7
commit a8cd9a9581
No known key found for this signature in database
GPG key ID: EA868E12D0257E3C

View file

@ -2,13 +2,14 @@
## Python packages ## Python packages
- [Click](https://click.palletsprojects.com/) for the command-line interface ; - [Click](https://click.palletsprojects.com/) for the command-line interface;
- [FastAPI](https://fastapi.tiangolo.com/) is the framework that allows us to expose the HTTP API ; - [FastAPI](https://fastapi.tiangolo.com/) is the framework that allows us to expose the HTTP API;
- [HTTPX](https://www.python-httpx.org/) is used to issue asynchronous requests in the agents ; - [HTTPX](https://www.python-httpx.org/) is used to issue asynchronous requests in the agents;
- [Jinja](https://jinja.palletsprojects.com/) is handling the templating ; - [Jinja](https://jinja.palletsprojects.com/) is handling the templating;
- [Pydantic](https://pydantic.dev/) is useful to ensure the data matches our expectactions ; - [Pydantic](https://pydantic.dev/) is useful to ensure the data matches our expectactions;
- [SQLAlchemy](https://www.sqlalchemy.org/) is the ORM we use, to connect to our database and issue queries ; - [SQLAlchemy](https://www.sqlalchemy.org/) is the ORM we use, to connect to our database and issue queries;
- [Tenacity](https://github.com/jd/tenacity) a small utility to retry a function in case an error occured ; - [Alembic](https://alembic.sqlalchemy.org) is used for DB migrations;
- [Tenacity](https://github.com/jd/tenacity) a small utility to retry a function in case an error occured;
- [Uvicorn](https://www.uvicorn.org/) is the tool used to run our server. - [Uvicorn](https://www.uvicorn.org/) is the tool used to run our server.
## CSS framework ## CSS framework