Updated README with info about Poetry

microsoft · Apr 19, 2024 · e244fdb · e244fdb
1 parent 74013da
commit e244fdb
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 25 deletions.
diff --git a/.backup.requirements-dev.txt b/.backup.requirements-dev.txt
diff --git a/.backup.requirements.txt b/.backup.requirements.txt
diff --git a/README.md b/README.md
@@ -15,12 +15,20 @@ This repo contains sample code for a simple chat webapp that integrates with Azu
 The following tools should be installed prior to running the project locally.
 
 #### Frontend tools
-- nodejs 21+
+- Node.js 21+
 
 #### Backend tools
 - Python 3.10+
 - [Poetry](https://python-poetry.org/docs/#installation)
 
+## Development workflow
+
+This project uses [Poetry](https://python-poetry.org/) to manage project dependencies.  It is recommended to follow these steps for managing your local Python development environment.
+
+1. Run `poetry install` to bootstrap your local development environment with this project and its dependencies.  This command will create a virtual environment containing all of the project dependencies under the `.venv` directory.
+2. Use the `poetry add`, `poetry update` and `poetry remove` commands to modify packages in the environment.  See the [Poetry CLI](https://python-poetry.org/docs/cli) docs for more information about arguments to those commands. 
+3. When you are ready to deploy your app or submit a PR, generate a requirements.txt file for the app using the command `poetry export --dev --without-hashes --format=requirements.txt --output=requirements-dev.txt`.
+
 ## Deploy the app
 
 ### Deploy with Azure Developer CLI