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
6 changes: 0 additions & 6 deletions .flake8

This file was deleted.

4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ updates:
interval: weekly
versioning-strategy: increase-if-necessary
groups:
update-dependencies:
dependencies:
applies-to: version-updates
patterns:
- "*"
Expand All @@ -21,7 +21,7 @@ updates:
schedule:
interval: weekly
groups:
update-actions:
github-actions:
applies-to: version-updates
patterns:
- "*"
Expand Down
8 changes: 3 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ project: # Rename project (run once)

poetry: # Install Poetry
pipx install -f poetry
poetry self add poetry-plugin-shell

venv:
poetry shell
poetry env activate

install: # Install dependencies and project
poetry install
Expand All @@ -42,10 +41,9 @@ precommit: # Install pre-commit hooks
pre-commit: precommit

lint:
poetry run black .
poetry run isort .
poetry run ruff format
poetry run ruff check --fix
poetry run pyright .
poetry run flake8 .

coverage:
poetry run coverage run -m pytest .
Expand Down
11 changes: 6 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Python Project Template
# Python Project Template
![Python](https://img.shields.io/badge/python-3.12+-3776AB.svg?logo=python&style=flat-square)
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-D7FF64.svg?logo=ruff&style=flat-square)](https://docs.astral.sh/ruff)
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](/LICENSE)

A Python project template that comes out of the box with configuration for:

- Packaging and dependency management using [Poetry](https://python-poetry.org)
- Command Line Interface (CLI) using [click](https://click.palletsprojects.com)
- Testing using [pytest](https://pytest.org)
- Code coverage using [coverage](https://coverage.readthedocs.io)
- Fomatting using [black](https://black.readthedocs.io)
- Import sorting using [isort](https://pycqa.github.io/isort)
- Fomatting, import sorting, and linting using [ruff](https://docs.astral.sh/ruff)
- Type checking using [pyright](https://microsoft.github.io/pyright)
- Linting usig [flake8](https://flake8.pycqa.org)
- Pre-commit validations using [pre-commit](https://pre-commit.com)
- Workflow automation using [GitHub Actions](https://github.com/features/actions)
- Automated dependency update using [Dependabot](https://docs.github.com/en/code-security/dependabot)
Expand Down Expand Up @@ -161,7 +163,6 @@ make local
│ └── docs.yml # Woukflow to publish documentation
├── .gitignore # Git-ignored file list
├── .pre-commit-config.yaml # Pre-commit configuration file
├── .flake8 # flake8 configuration file
├── .vscode # VS code folder
│ └── settings.json # VS code settings
├── .dockerignore # Docker-ignored file list
Expand Down
Loading