From a4057c4d1684d3aeae8db9c8e98be4bcb5cb3fbd Mon Sep 17 00:00:00 2001 From: Stefan Stammberger Date: Mon, 20 Sep 2021 19:44:11 +0200 Subject: [PATCH] docs: update readme with poetry shell command --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 95db461..e10abed 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ If you need a easy option to run a simple bitcoind & lnd client, [Polar](https:/ You will need to have [Python in version 3.7](https://www.python.org/downloads/) installed and have the `.env` see [Configuration](#Configuration) configured correctly first. ->**NOTE:** To setup a development environment for BlitzAPI skip to the [Development](#Development) section. +>:warning: To setup a development environment for BlitzAPI skip to the [Development](#Development) section. To install the dependencies, run @@ -31,15 +31,15 @@ After that, you can run the application with ## Development For development it is recommended to have python-poetry installed. Install instructions can be found [here](https://python-poetry.org/docs/master/#installation) -Install dependencies with all dev dependencies: +From within the blitz_api folder open a shell via `poetry shell`. -`poetry install` +Install dependencies with all dev dependencies: `poetry install` If any dependencies have changed it becomes necessary to freeze all requirements to requirements.txt: `poetry export -f requirements.txt --output requirements.txt` -> **Note**: This will skip all dev dependencies by default.
+> :information_source: This will skip all dev dependencies by default.
> This step is required to avoid having to install poetry for final deployment.