diff --git a/python/README.md b/python/README.md index 13a4997d..74891217 100644 --- a/python/README.md +++ b/python/README.md @@ -7,9 +7,23 @@ For an outline of the logic behind the rules engine and a glossary of common ter Simple steps for development setup: 1. Clone the git repository. -3. Navigate to any directory and create a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) and activate it -4. The following commands can be run from inside the rules-engine folder while the virtual environment is active -2. `pip install -e .` builds the [python egg](https://stackoverflow.com/questions/2051192/what-is-a-python-egg) for the rules engine and then installs the rules engine -3. `pip install -r requirements-dev.txt` which installs the required libraries +2. Navigate to any directory and create a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) and activate it +3. The following commands can be run from inside the rules-engine folder while the virtual environment is active +4. `pip install -e .` builds the [python egg](https://stackoverflow.com/questions/2051192/what-is-a-python-egg) for the rules engine and then installs the rules engine +5. `pip install -r requirements-dev.txt` which installs the required libraries Then, you should be able to run `pytest`, also from any directory, and see tests run successfully. + +## Codespaces +The default codespace does not have the version of Python pre-installed that is used to develop the rules engine. You _can_ use it and update it to install the correct Python vsion, but this takes time. + +Instead, you can spin up a codespace with the correct version like so: + +1. navigate to the green "code" dropdown +2. select the "codespaces" tab +3. select the "..." menu +4. select "new with options" +5. on the options screen, under "Dev container configuration", select "Rules engine" +6. click "Create codespace" + +![codespaces screenshot](docs/codespaces.png) \ No newline at end of file diff --git a/python/docs/codespaces.png b/python/docs/codespaces.png new file mode 100644 index 00000000..65809933 Binary files /dev/null and b/python/docs/codespaces.png differ