Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ your repository's standards.
--->
- [ ] The code runs successfully.

```commandline
```console
HERE IS SOME COMMAND LINE OUTPUT
```
8 changes: 4 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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]
Expand Down
16 changes: 8 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading