Add docs on how to run tests (#53)

* add docs on how to run tests, use `sys.executable` instead of `"python"` * Update README.md * Update README.md Co-authored-by: Christian Clauss <[email protected]> * Update test_outputs.py * Update _prepare_outputs.py * Update lint_python.yml --------- Co-authored-by: Christian Clauss <[email protected]>
nodejs · Mar 24, 2024 · 27fbbaf · 27fbbaf
1 parent 5f90621
commit 27fbbaf
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/.github/workflows/lint_python.yml b/.github/workflows/lint_python.yml
@@ -1,5 +1,9 @@
 name: lint_python
-on: [pull_request, push]
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
 jobs:
   lint_python:
     runs-on: ubuntu-latest

diff --git a/README.md b/README.md
@@ -39,3 +39,14 @@ Suggested code hygiene:
 $ ruff --show-fixes --show-source .
 $ black .
 ```
+
+## Running tests locally
+
+```sh
+python3 -m venv .venv
+source .venv/bin/activate
+pip install --upgrade pip
+pip install pytest
+pip install --editable ".[dev]"
+pytest
+```