aboutsummaryrefslogtreecommitdiff
path: root/TESTING.md
diff options
context:
space:
mode:
authorRaul Farkas <raul.farkas@arm.com>2023-03-15 10:15:42 +0000
committerRaul Farkas <raul.farkas@arm.com>2023-03-24 11:09:21 +0000
commit430002df36f79d035e31e8304fb8b176129cd3cc (patch)
tree47832ae5bbcd825a1c90f1b6fef71e6aa4a2a35e /TESTING.md
parentfcda685927ae4b29a79e10eca051b48acbf46f71 (diff)
downloadethos-u-vela-430002df36f79d035e31e8304fb8b176129cd3cc.tar.gz
MLBEDSW-7429: Add dev dependencies
Add dev dependencies to pyproject.toml. They can be installed by using: `pip install ethos-u-vela[dev]` Change-Id: I212ed7c39c9c7e93896a1e6a25cff7c7102d2c7f Signed-off-by: Raul Farkas <raul.farkas@arm.com>
Diffstat (limited to 'TESTING.md')
-rw-r--r--TESTING.md24
1 files changed, 14 insertions, 10 deletions
diff --git a/TESTING.md b/TESTING.md
index dba13056..34b15118 100644
--- a/TESTING.md
+++ b/TESTING.md
@@ -4,8 +4,8 @@
Vela's Python codebase is PEP8 compliant with the exception of a 120 character
line length. The following code formatting and linting tools are run on all the
-Python files (excluding the directories `ethosu/vela/tflite/` and
-`ethosu/vela/ethos_u55_regs` because they contain auto-generated code):
+Python files (excluding the directories `ethosu/vela/tflite/`, `ethosu/vela/tosa/`,
+and `ethosu/vela/ethos_u55_regs` because they contain auto-generated code):
* mypy (code linter)
* reorder-python-import (code formatter)
@@ -21,17 +21,21 @@ This is also used to run the following test and coverage tools:
### Installation
-To install pre-commit, pytest and pytest-cov use the following command:
+To install the development dependencies, use the following command:
-```bash
-pip install pre-commit
-...
-pip install pytest
-...
-pip install pytest-cov
+``` bash
+pip install -e .[dev]
```
-The remaining tools will all be installed automatically upon first use.
+This command will install the following tools:
+
+* pytest
+* pytest-cov
+* pre-commit
+* build
+* setuptools_scm
+
+The remaining tools will all be installed automatically upon first use of pre-commit.
### Add pre-commit hook (Automatically running the tools)