Update Developer setup authored by Mark Hewitt's avatar Mark Hewitt
......@@ -28,11 +28,18 @@ python3 -m venv .env
. ./.env/bin/activate
```
Next install the package in developer mode and any necessary development packages.
(Optional) If you want to be able to make changes to the osdu-sdk that is used for communication with the OSDU API's then this should also be installed in developer mode. If you omit this step then you will use the published version of the sdk referenced in setup.py
```bash
pip install -e ..\osdu-sdk-python
pip install -r dev-requirements.txt
```
Next install the main cli package in developer mode along with any necessary development packages.
```bash
pip install -e .
pip install -r requirements.txt
pip install -r dev-requirements.txt
```
You should now be able to run the command line.
......@@ -58,6 +65,7 @@ Linux / MacOS
The above can take the following optional arguments to just run specific portions of the validation:
* lint
* tests
* format
e.g.
```bash
......
......