From 24c7645600fdb8e31097b57bad81ebc3235e85b7 Mon Sep 17 00:00:00 2001 From: rfabbri Date: Sat, 19 Jul 2025 23:14:36 +0200 Subject: [PATCH] Add dev extras and testing instructions --- README.md | 15 +++++++++++++++ pyproject.toml | 1 + 2 files changed, 16 insertions(+) diff --git a/README.md b/README.md index e01e971..fc352e4 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,21 @@ This install method is especially useful when reloading the modified module in s Every dependency is installed by default by `pip`, but you can take a look at [requirements.txt](https://github.com/ttm/music/blob/master/requirements.txt). +### Testing + +The packages required to run the test suite are available via the `dev` +extras defined in `pyproject.toml`. Install them with: + +```console +pip install -e '.[dev]' +``` + +You can then run the tests using `pytest`: + +```console +pytest +``` + ## Examples Inside [the examples folder](https://github.com/ttm/music/tree/master/examples) you can find some scripts that use the main features of Music. diff --git a/pyproject.toml b/pyproject.toml index 4fbaf3e..684b31b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,6 +17,7 @@ dependencies = [ 'sympy >= 1.12', 'termcolor >= 2.4.0', ] +optional-dependencies = { dev = ['pytest >= 8.2'] } classifiers = [ 'Programming Language :: Python :: 3', 'License :: OSI Approved :: MIT License',