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
5 changes: 5 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,8 @@ MD024:
siblings_only: true

MD038: false

# MD060/table-column-style
# Disabled: emoji columns have inconsistent display width vs character
# count, making "aligned" pipe style unachievable by hand.
MD060: false
20 changes: 13 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
rev: v6.0.0
hooks:
- id: check-yaml
stages: [pre-commit]
Expand All @@ -13,22 +13,28 @@ repos:
stages: [pre-commit]

- repo: https://github.com/abravalheri/validate-pyproject
rev: v0.24.1
rev: v0.25
hooks:
- id: validate-pyproject

- repo: https://github.com/codespell-project/codespell
rev: v2.4.1
rev: v2.4.3
hooks:
- id: codespell

- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.45.0
- repo: https://github.com/DavidAnson/markdownlint-cli2
rev: v0.23.2
hooks:
- id: markdownlint-fix
- id: markdownlint-cli2
exclude: ^\.claude/

- repo: https://github.com/fastai/nbdev
rev: 3.3.11
hooks:
- id: nbdev-clean

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.12.2
rev: v0.16.2
hooks:
- id: ruff-check
args: [--fix, --exit-non-zero-on-fix]
Expand Down
18 changes: 8 additions & 10 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ get-started: pre-install venv

# Update project software versions in requirements
update-reqs:
uv lock
uv lock --upgrade
uv sync
pre-commit autoupdate

# create virtual environment
Expand All @@ -33,9 +34,6 @@ venv:
uv tool install pre-commit
uv run pre-commit install

activate-venv:
uv shell

# launch jupyter lab
lab:
uv run jupyter lab
Expand Down Expand Up @@ -66,15 +64,15 @@ lint-sql:

# Format all markdown and config files
fmt-markdown:
uv run mdformat .
markdownlint-cli2 --config {{ justfile_directory() }}/.markdownlint.yaml "**/*.{md,qmd}" "#.venv" --fix

# Format a single markdown file, "f"
fmt-md f:
uv run mdformat {{ f }}
markdownlint-cli2 --config {{ justfile_directory() }}/.markdownlint.yaml {{ f }} --fix

# Check format of all markdown files
fmt-check-markdown:
uv run mdformat --check .
markdownlint-cli2 --config {{ justfile_directory() }}/.markdownlint.yaml "**/*.{md,qmd}" "#.venv"

fmt-all: lint-py fmt-python lint-sql fmt-markdown

Expand All @@ -85,13 +83,13 @@ pre-commit-run:
[windows]
pre-install:
winget install Casey.Just astral-sh.uv GitHub.cli Posit.Quarto OpenJS.NodeJS
npm install -g markdownlint-cli
npm install -g markdownlint-cli2

[linux]
pre-install:
brew install just uv gh markdownlint-cli
brew install just uv gh markdownlint-cli2

[macos]
pre-install:
brew install just uv gh markdownlint-cli
brew install just uv gh markdownlint-cli2
brew install --cask quarto
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ should also have Git installed
To get started, make sure you have `Just` installed on your computer by running the
following from the command line:

| Platform | Commands |
| --------- | ------------------------------------------------------------------- |
| Platform | Commands |
| --------- | ------------------------------------------------------------------------ |
| Windows | `winget install Git.Git Casey.Just astral-sh.uv GitHub.cli Posit.Quarto` |
| Mac/Linux | `brew install just uv gh` |
| Mac/Linux | `brew install just uv gh` |

This will make sure that you have the latest version of `Just`, as well as
[uv](https://docs.astral.sh/uv/) (installer for Python) and
Expand Down
8 changes: 2 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,8 @@ dependencies = [
]


[tool.uv]
dev-dependencies = [
"codespell>=2.4.1",
"pre-commit>=4.2.0",
"ruff>=0.7.4",
]
[dependency-groups]
dev = ["codespell>=2.4.1", "pre-commit>=4.2.0", "ruff>=0.7.4"]

[tool.ruff]
line-length = 88
Expand Down
Loading
Loading