Use justfile

docs/contributing.md

@@ -78,9 +78,11 @@ installed and ready to go.
 
 7. Once you're done, validate that all unit and functional tests are passing:
     ```bash
-    make test
+    just test
     ```
 
+    Note: running this command requires you to have just installed, see [here](https://just.systems/man/en/installation.html).
+
 8. Before submitting a pull request, you should also run [tox](https://tox.wiki/en/latest/). This will run the tests across all the Python versions that _deptry_ supports:
     ```bash
     tox

justfile

@@ -0,0 +1,40 @@
+default:
+    @just --list
+
+# Install the uv environment.
+install:
+    @echo "🚀 Creating virtual environment using uv"
+    uv sync
+
+# Run code quality tools.
+check:
+    @echo "🚀 Linting code: Running pre-commit"
+    pre-commit run -a
+    @echo "🚀 Checking for dependency issues: Running deptry"
+    uv run deptry python
+
+# Run all tests.
+test: test-unit test-functional
+
+# Run unit tests.
+test-unit:
+    @echo "🚀 Running unit tests"
+    uv run pytest tests/unit
+
+# Run functional tests.
+test-functional:
+    @echo "🚀 Running functional tests"
+    uv run pytest tests/functional
+
+# Build wheel and sdist files using maturin.
+build:
+    @echo "🚀 Creating wheel and sdist files"
+    maturin build
+
+# Test if documentation can be built without warnings or errors.
+docs-test:
+    uv run mkdocs build -s
+
+# Build and serve the documentation.
+docs:
+    uv run mkdocs serve