diff --git a/README.md b/README.md index 8446146755..73f72daeb7 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ docker compose up -d git clone https://github.com/prowler-cloud/prowler cd prowler/api poetry install -poetry shell +eval $(poetry env activate) set -a source .env docker compose up postgres valkey -d @@ -127,6 +127,11 @@ cd src/backend python manage.py migrate --database admin gunicorn -c config/guniconf.py config.wsgi:application ``` +> [!IMPORTANT] +> Starting from Poetry v2.0.0, `poetry shell` has been deprecated in favor of `poetry env activate`. +> +> If you poetry version is below 2.0.0 you must keep using `poetry shell` to activate your environment. +> In case you have any doubts, consult the Poetry environment activation guide: https://python-poetry.org/docs/managing-environments/#activating-the-environment > Now, you can access the API documentation at http://localhost:8080/api/v1/docs. @@ -136,7 +141,7 @@ gunicorn -c config/guniconf.py config.wsgi:application git clone https://github.com/prowler-cloud/prowler cd prowler/api poetry install -poetry shell +eval $(poetry env activate) set -a source .env cd src/backend @@ -149,7 +154,7 @@ python -m celery -A config.celery worker -l info -E git clone https://github.com/prowler-cloud/prowler cd prowler/api poetry install -poetry shell +eval $(poetry env activate) set -a source .env cd src/backend @@ -205,10 +210,16 @@ Python > 3.9.1, < 3.13 is required with pip and poetry: ``` console git clone https://github.com/prowler-cloud/prowler cd prowler -poetry shell +eval $(poetry env activate) poetry install python prowler.py -v ``` +> [!IMPORTANT] +> Starting from Poetry v2.0.0, `poetry shell` has been deprecated in favor of `poetry env activate`. +> +> If you poetry version is below 2.0.0 you must keep using `poetry shell` to activate your environment. +> In case you have any doubts, consult the Poetry environment activation guide: https://python-poetry.org/docs/managing-environments/#activating-the-environment + > If you want to clone Prowler from Windows, use `git config core.longpaths true` to allow long file paths. # 📐✏️ High level architecture