commit 430002df36f79d035e31e8304fb8b176129cd3cc
author Raul Farkas <raul.farkas@arm.com> Wed Mar 15 10:15:42 2023 +0000
committer Raul Farkas <raul.farkas@arm.com> Fri Mar 24 11:09:21 2023 +0000
tree 47832ae5bbcd825a1c90f1b6fef71e6aa4a2a35e
parent fcda685927ae4b29a79e10eca051b48acbf46f71

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>

README.md

diff --git a/README.md b/README.md
index 8428e59..e31294f 100644
--- a/README.md
+++ b/README.md
@@ -100,7 +100,7 @@
 ```
 
 If you plan to contribute to the Vela project (highly encouraged!) then it is
-recommended to install Vela along with the pre-commit tools (see
+recommended to install Vela with the development dependencies (see
 [Vela Testing](TESTING.md) for more details).
 
 ## Running

TESTING.md

diff --git a/TESTING.md b/TESTING.md
index dba1305..34b1511 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 @@
 
 ### 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)
 

pyproject.toml

diff --git a/pyproject.toml b/pyproject.toml
index d8cbe66..0c88abb 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -41,6 +41,15 @@
 ]
 dynamic = ["readme", "version"]
 
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-cov",
+    "pre-commit",
+    "build",
+    "setuptools_scm[toml]<6"
+]
+
 [project.urls]
 Homepage = "https://git.mlplatform.org/ml/ethos-u/ethos-u-vela.git/"