merge tests (#28)

* merge tests

* Update README.md

.github/workflows/unittests.yaml → .github/workflows/tests.yaml

@@ -1,6 +1,6 @@
 # Run python unit tests
 
-name: unittests
+name: tests
 
 on:
   push:
@@ -37,5 +37,8 @@ jobs:
         cache-to: type=registry,ref=${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.REPO_NAME }}:cache,mode=max
         outputs: type=docker
     -
-      name: Run tests
+      name: Unit tests
       run: docker run ${{ secrets.REPO_NAME }}:gha pytest
+    -
+      name: Style tests
+      run: docker run ${{ secrets.REPO_NAME }}:gha pre-commit run --all-files

README.md

@@ -31,7 +31,28 @@ Code development is in a Docker image, use these steps to spin up the image
     exit
     ```
 
-## Updating the Environment
+## Develop without Docker
+1. Create a Python virtual environment
+    ```
+    python3 -m venv <environment-name>
+    ```
+2. In this virtual environment, install necessary requirements files
+    ```
+    python -m pip install -r requirements/dev.txt
+    python -m pip install -r requirements/prod.txt
+    ```
+3. Build and install
+    ```
+    python -m build
+    python -m pip install -e . --no-deps
+    ```
+4. Test things
+    ```
+    pre-commit run --all-files
+    pytest
+    ```
+
+## Updating requirements folder
 1. Use pip-compile to build a new pinned requirements file.
     ```
     pip-compile requirements/prod.in --output-file=requirements/prod.txt