Update documentation and packages (#18)

michplunkett · web-flow · commit a8da61f0eded · 2025-04-23T16:49:15.000-05:00
## Describe your changes Updated the above packages and implemented the correct version of default into the `Makefile`. ## Checklist before requesting a review - [x] The code runs successfully. ```console michaelp@Mac python-project-template % make env uv venv Using CPython 3.12.0 interpreter at: /Users/michaelp/.pyenv/versions/3.12.0/bin/python3.12 Creating virtual environment at: .venv Activate with: source .venv/bin/activate michaelp@Mac python-project-template % source .venv/bin/activate (python-project-template) michaelp@Mac python-project-template % make uv pip compile --generate-hashes pyproject.toml > requirements.txt Resolved 19 packages in 17ms pre-commit run --all-files [INFO] Installing environment for https://github.com/nbQA-dev/nbQA. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/nbQA-dev/nbQA. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/nbQA-dev/nbQA. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/PyCQA/isort. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/astral-sh/ruff-pre-commit. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... nbqa-ruff................................................................Passed nbqa-black...............................................................Passed nbqa-isort...............................................................Passed trim trailing whitespace.................................................Passed check docstring is first.................................................Passed check that executables have shebangs.................(no files to check)Skipped check json...........................................(no files to check)Skipped check for case conflicts.................................................Passed check toml...............................................................Passed check for merge conflicts................................................Passed check xml............................................(no files to check)Skipped check yaml...............................................................Passed fix end of files.........................................................Passed check for broken symlinks............................(no files to check)Skipped mixed line ending........................................................Passed sort simple yaml files...............................(no files to check)Skipped fix python encoding pragma (deprecated)..................................Passed pretty format json...................................(no files to check)Skipped check blanket noqa.......................................................Passed check for not-real mock methods..........................................Passed check for eval().........................................................Passed use logger.warning(......................................................Passed Run isort to sort imports................................................Passed ruff.....................................................................Passed ruff-format..............................................................Passed (python-project-template) michaelp@Mac python-project-template % make test pytest -vs tests/ ============================================================================================= test session starts ============================================================================================== platform darwin -- Python 3.11.11, pytest-7.3.1, pluggy-1.0.0 -- /opt/homebrew/opt/python@3.11/bin/python3.11 cachedir: .pytest_cache rootdir: /Users/michaelp/Documents/GitHub/python-project-template plugins: anyio-3.6.2 collected 1 item tests/test_example.py::test_example PASSED ============================================================================================== 1 passed in 0.00s =============================================================================================== (python-project-template) michaelp@Mac python-project-template % make test-and-fail pytest -vsx tests/ ============================================================================================= test session starts ============================================================================================== platform darwin -- Python 3.11.11, pytest-7.3.1, pluggy-1.0.0 -- /opt/homebrew/opt/python@3.11/bin/python3.11 cachedir: .pytest_cache rootdir: /Users/michaelp/Documents/GitHub/python-project-template plugins: anyio-3.6.2 collected 1 item tests/test_example.py::test_example PASSED ============================================================================================== 1 passed in 0.00s =============================================================================================== (python-project-template) michaelp@Mac python-project-template % make run python -m project oh, what up? (python-project-template) michaelp@Mac python-project-template % ```
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -18,6 +18,6 @@ your repository's standards.
 --->
 - [ ] The code runs successfully.
 
-```commandline
+```console
 HERE IS SOME COMMAND LINE OUTPUT
 ```
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/nbQA-dev/nbQA
-    rev: 1.8.5
+    rev: 1.9.1
     hooks:
       - id: nbqa-ruff
         args:
@@ -17,7 +17,7 @@ repos:
           - --profile=black
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: check-docstring-first
@@ -48,7 +48,7 @@ repos:
       - id: python-no-log-warn
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+    rev: 6.0.1
     hooks:
       - id: isort
         name: Run isort to sort imports
@@ -61,7 +61,7 @@ repos:
           - --line-length=80
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.10
+    rev: v0.11.6
     hooks:
       - id: ruff
         types_or: [python,pyi]
diff --git a/Makefile b/Makefile
@@ -1,27 +1,27 @@
 # Here is some general information on Makefile's so that you can grow this out:
 # https://www.gnu.org/software/make/manual/html_node/Introduction.html
-default: create-requirements lint
+.DEFAULT_GOAL := lint
 
 .PHONY: env
 env:
 	uv venv
 
-.PHONY: lint
-lint:
-	uv run pre-commit run --all-files
-
 .PHONY: create-requirements
 create-requirements:
 	uv pip compile --generate-hashes pyproject.toml > requirements.txt
 
+.PHONY: lint
+lint: create-requirements
+	pre-commit run --all-files
+
 .PHONY: test
 test:
-	uv run pytest -vs tests/
+	pytest -vs tests/
 
 .PHONY: test-and-fail
 test-and-fail:
-	uv run pytest -vsx tests/
+	pytest -vsx tests/
 
 .PHONY: run
 run:
-	uv run python -m project
+	python -m project
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ lifting for a python project so that people can hit the ground running with thei
 
 ## Standard Commands
 - `make create-requirements`: Creates and/or updates the `requirements.txt` file.
-- `make env`: Creates or activates a `uv` virtual environment.
+- `make env`: Creates a `uv` virtual environment.
 - `make lint`: Runs `pre-commit`.
 - `make run`: Runs the `main` function in the `project` folder.
 - `make test`: Runs test cases in the `tests` directory.
diff --git a/requirements.txt b/requirements.txt
