diff --git a/docs/developer/dependencies.md b/docs/developer/dependencies.md index 633d519..b22ba95 100644 --- a/docs/developer/dependencies.md +++ b/docs/developer/dependencies.md @@ -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 :-) diff --git a/docs/developer/projects.md b/docs/developer/projects.md deleted file mode 100644 index 41ff401..0000000 --- a/docs/developer/projects.md +++ /dev/null @@ -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 :-) diff --git a/docs/index.md b/docs/index.md index d72c8f8..cafa939 100644 --- a/docs/index.md +++ b/docs/index.md @@ -61,7 +61,6 @@ developer/new-check developer/models developer/migrations developer/tests -developer/projects -changelog +developer/dependencies ```