✨ add dev dependencies

.github/workflows/cicd.yml

@@ -126,4 +126,4 @@ jobs:
               # remove repository key to set the default to pypi (not test.pypi.org) 
               repository-url: https://test.pypi.org/legacy/
               user: __token__
-              password: ${{ secrets.PYPI_API_TOKEN }}
+              password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -124,7 +124,7 @@ docs\conf.py:
 Install package so that new code is picked up in a restared python interpreter:
 
 ```
-pip install -e .
+pip install -e ".[dev]"
 ```
 
 ## TestPyPI
@@ -143,4 +143,4 @@ The documentation is build using readthedocs automatically. See
 [project on Readthedocs](https://readthedocs.org/projects/rasmussenlab-python-package/).
 
 - make sure to enable build from PRs in the settings (advanded settings)
-- checkout configuration file: [`.readthedocs.yaml`](.readthedocs.yaml)
+- checkout configuration file: [`.readthedocs.yaml`](.readthedocs.yaml)

docs/conf.py

@@ -57,18 +57,21 @@
 nb_merge_streams = True
 
 # https://myst-nb.readthedocs.io/en/latest/authoring/custom-formats.html#write-custom-formats
-nb_custom_formats = {
-    ".py": ["jupytext.reads", {"fmt": "py:percent"}]
-}
+nb_custom_formats = {".py": ["jupytext.reads", {"fmt": "py:percent"}]}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db",
-                    ".DS_Store", "jupyter_execute", "conf.py",]
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "jupyter_execute",
+    "conf.py",
+]
 
 
 # Intersphinx options

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 authors = [
-  {name = "Jakob Nybo Nissen", email = "[email protected]"},
-  {name = "Henry Webel", email = "[email protected]"},
+  { name = "Jakob Nybo Nissen", email = "[email protected]" },
+  { name = "Henry Webel", email = "[email protected]" },
 ]
 description = "A small example package"
 name = "rasmussenlab-mockup"
@@ -31,10 +31,11 @@ docs = [
   "sphinx-new-tab-link!=0.2.2",
   "jupytext",
 ]
+dev = ["black", "ruff", "pytest"]
 
 # Configure the Ruff linter: Ignore error number 501
 [tool.ruff]
-ignore = ["E501"]
+lint.ignore = ["E501"]
 
 [build-system]
 build-backend = "setuptools.build_meta"