mirror of
https://framagit.org/framasoft/framaspace/argos.git
synced 2025-04-28 18:02:41 +02:00
docs: rename projects to dependencies
For a better clarity while reading the documentation.
This commit is contained in:
parent
2064d94fb9
commit
0659e28c3e
3 changed files with 16 additions and 28 deletions
|
@ -1,11 +1,18 @@
|
|||
# Installing for development
|
||||
# Main dependencies used by Argos
|
||||
|
||||
To install all what you need to develop on Argos, do:
|
||||
## Python packages
|
||||
|
||||
```bash
|
||||
git clone https://framagit.org/framasoft/framaspace/argos.git
|
||||
cd argos
|
||||
make develop
|
||||
```
|
||||
- [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;
|
||||
- [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;
|
||||
- [Gunicorn](https://gunicorn.org/) is the recommended WSGI HTTP server for production.
|
||||
|
||||
It will create a virtualenv and install all the needed dependencies in it.
|
||||
## CSS framework
|
||||
|
||||
- [Pico.css](https://picocss.com/), a minimalist CSS framework, which does just what you need :-)
|
||||
|
|
|
@ -1,18 +0,0 @@
|
|||
# Main projects used by Argos
|
||||
|
||||
## Python packages
|
||||
|
||||
- [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;
|
||||
- [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;
|
||||
- [Gunicorn](https://gunicorn.org/) is the recommended WSGI HTTP server for production.
|
||||
|
||||
## CSS framework
|
||||
|
||||
- [Pico.css](https://picocss.com/), a minimalist CSS framework, which does just what you need :-)
|
|
@ -61,7 +61,6 @@ developer/new-check
|
|||
developer/models
|
||||
developer/migrations
|
||||
developer/tests
|
||||
developer/projects
|
||||
changelog
|
||||
developer/dependencies
|
||||
```
|
||||
|
||||
|
|
Loading…
Reference in a new issue