📝 docs: enhance project list with descriptions

This commit is contained in:
Alexis Métaireau 2023-12-16 20:46:01 +01:00
parent 4cfc845fca
commit d6b53bed91
2 changed files with 12 additions and 12 deletions

View file

@ -1,16 +1,16 @@
# Main projects and Python packages used by Argos
# Main projects used by Argos
## Python packages
- [Click](https://click.palletsprojects.com/)
- [FastAPI](https://fastapi.tiangolo.com/)
- [HTTPX](https://www.python-httpx.org/)
- [Jinja](https://jinja.palletsprojects.com/)
- [Pydantic](https://pydantic.dev/)
- [SQLAlchemy](https://www.sqlalchemy.org/)
- [Tenacity](https://github.com/jd/tenacity)
- [Uvicorn](https://www.uvicorn.org/)
- [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 ;
- [HTTPX](https://www.python-httpx.org/) is used to issue asynchronous requests in the agents ;
- [Jinja](https://jinja.palletsprojects.com/) is handling the templating ;
- [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 ;
- [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.
## CSS framework
- [Pico.css](https://picocss.com/)
- [Pico.css](https://picocss.com/), a minimalist CSS framework, which does just what you need :-)

View file

@ -51,11 +51,11 @@ You can run the agent on the same machine as the server, or on a different machi
argos agent http://localhost:8000 "<auth-token>"
```
## Running cleaning tasks
## Cleaning the database
You also have to run cleaning tasks periodically. `argos server clean --help` will give you more information on how to do that.
Here is a crontab example:
Here is a crontab example, which will clean the db each hour:
```bash
# Run the cleaning tasks every hour (at minute 7)