Pre commit

.github/workflows/regression-tests.yml

@@ -27,9 +27,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install numpy scipy numpy_groupies pytest-cov coverage coveralls \
-          sphinx_rtd_theme isort black pylint mypy
-        pip install .
+        python -m pip install coverage coveralls sphinx_rtd_theme
+        pip install ".[dev]"
     - name: Check auto-formatters
       run: |
         isort --check .

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 5.11.5
+    hooks:
+      - id: isort
+        name: isort (python)
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+        language_version: python

CONTRIBUTOR_GUIDE.md

@@ -7,15 +7,15 @@ current or filing a new [issue](https://github.com/sandialabs/pyttb/issues).
 ## Working on PYTTB locally
 1. clone your fork and enter the directory
     ```
-    git clone [email protected]:<your username>/pyttb.git
-    cd pyttb
+    $ git clone [email protected]:<your username>/pyttb.git
+    $ cd pyttb
     ```
     1. setup your desired python environment as appropriate
 
 1. install dependencies
     ```
-    We use a mix of pyproject.toml, and setup.py currently. We are
-    still iterating on simplifying the setup procedure.
+    $ pip install -e ".[dev]"
+    $ make install_dev # shorthand for above
     ```
 
 1. Checkout a branch and make your changes
@@ -25,9 +25,10 @@ current or filing a new [issue](https://github.com/sandialabs/pyttb/issues).
 1. Formatters and linting
    1. Run autoformatters from root of project (they will change your code)
        ```commandline
-       isort .
-       black .
+       $ isort .
+       $ black .
        ```
+      1. [We](./.pre-commit-config.yaml) optionally support [pre-commit hooks](https://pre-commit.com/) for this
    1. Pylint and mypy coverage is work in progress (these only raise errors)
       ```commandline
       mypy pyttb/

Makefile

@@ -14,9 +14,24 @@ BUILDDIR      = ./docs/build
 
 # Put it first so that "make" without argument is like "make help".
 help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@echo "install: Install release build"
+	@echo "install_dev: Install dev build"
+	@echo "install_docs: Install docs build"
+	@echo "docs_help: Show additional docs commands"
+
+.PHONY: help install install_dev install_docs Makefile
+
+install:
+	python -m pip install -e .
 
-.PHONY: help Makefile
+install_dev:
+	python -m pip install -e ".[dev]"
+
+install_docs:
+	python -m pip install -e ".[doc]"
+
+docs_help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

pyproject.toml

@@ -26,6 +26,22 @@ homepage = "https://github.com/sandialabs/pyttb"
 coverage = "https://coveralls.io/github/sandialabs/pyttb"
 documentation = "https://pyttb.readthedocs.io"
 
+[project.optional-dependencies]
+dev = [
+    "black",
+    "isort",
+    "pylint",
+    "mypy",
+    "pytest",
+    "pytest-cov",
+]
+doc = [
+    "sphinx_rtd_theme",
+]
+
+[tool.setuptools]
+packages=["pyttb"]
+
 [build-system]
 requires = ["setuptools>=61.0", "numpy", "numpy_groupies", "scipy", "wheel"]
 build-backend = "setuptools.build_meta"