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
3 changes: 1 addition & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,11 @@
## Checklist ✅

- [ ] I have run and tested my changes locally
- [ ] I have limit this PR to less than 1000 lines of code change (if not, explain why)
- [ ] I have limited this PR to less than 1000 lines of code change (if not, explain why)
- [ ] I have updated/added tests to cover my changes (if applicable)
- [ ] I have updated/added requirements to cover my changes (if applicable)
- [ ] I have run linting and formatting on any code changes (if applicable)
- [ ] I have updated the documentation (README, etc.) accordingly
- [ ] I have reviewed and resolved any merge conflict

## Reviewer Emoji Legend

Expand Down
9 changes: 8 additions & 1 deletion .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install uv and set the python version
uses: astral-sh/setup-uv@v6
with:
python-version: '3.12'
enable-cache: true
cache-dependency-glob: "uv.lock"
- name: Sync uv
run: uv sync --locked --all-extras --dev
- uses: pre-commit/action@v3.0.1
32 changes: 16 additions & 16 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: check-yaml
stages: [commit]
stages: [pre-commit]
- id: check-json
stages: [commit]
stages: [pre-commit]
exclude: ^\.devcontainer/devcontainer\.json$
- id: check-toml
stages: [commit]
stages: [pre-commit]
- id: check-merge-conflict
stages: [commit]
stages: [pre-commit]

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

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

- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.41.0
rev: v0.45.0
hooks:
- id: markdownlint-fix

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.6.4
rev: v0.12.2
hooks:
- id: ruff-format
types_or: [python, pyi, jupyter]
- id: ruff
- id: ruff-check
args: [--fix, --exit-non-zero-on-fix]
types_or: [python, pyi, jupyter]
require_serial: true

- repo: https://github.com/crate-ci/typos
rev: v1.24.5
hooks:
- id: typos
- id: ruff-format
types_or: [python, pyi, jupyter]
8 changes: 6 additions & 2 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
{
"recommendations": [
"ms-python.python",
"charliermarsh.ruff",
"ms-toolsai.jupyter",
"ms-python.vscode-python-envs",
"charliermarsh.ruff",
"github.vscode-pull-request-github",
"davidanson.vscode-markdownlint",
"donjayamanne.python-environment-manager"
"quarto.quarto",
"skellock.just",
"yzhang.markdown-all-in-one",
"redhat.vscode-yaml"
]
}
12 changes: 5 additions & 7 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ system-info:
@echo "CPU architecture: {{ arch() }}"
@echo "Operating system type: {{ os_family() }}"
@echo "Operating system: {{ os() }}"
@echo "Home directory: {{ home_directory() }}"

# Clean venv
clean:
Expand All @@ -32,7 +31,7 @@ update-reqs:
venv:
uv sync
uv tool install pre-commit
pre-commit install
uv run pre-commit install

activate-venv:
uv shell
Expand Down Expand Up @@ -85,15 +84,14 @@ pre-commit-run:

[windows]
pre-install:
winget install Casey.Just astral-sh.uv GitHub.cli Posit.Quarto
winget install Casey.Just astral-sh.uv GitHub.cli Posit.Quarto OpenJS.NodeJS
npm install -g markdownlint-cli

[linux]
pre-install:
brew install just uv gh
curl -sfL https://github.com/quarto-dev/quarto-cli/releases/download/v1.5.54/quarto-1.5.54-linux-amd64.deb | sudo apt install ./quarto-1.5.54-linux-amd64.deb
rm quarto-1.5.54-linux-amd64.deb
brew install just uv gh markdownlint-cli

[macos]
pre-install:
brew install just uv gh
brew install just uv gh markdownlint-cli
brew install --cask quarto
39 changes: 22 additions & 17 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,27 +1,33 @@
[project]
name = "dms-dashboard"
name = "project-name"
version = "0.1.0"
description = "IPA Data Management System Dashboard."
description = "Project description"
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
"mdformat>=0.7.17",
"mdformat-config>=0.1.3",
"mdformat-frontmatter>=2.0.8",
"mdformat-gfm>=0.3.6",
"mdformat-pyproject>=0.0.1",
"ruff>=0.6.4",
"duckdb>=1.1.3",
"great-tables>=0.15.0",
"ipykernel>=6.29.5",
"jupyterlab>=4.2.5",
"sqlfluff>=3.1.1",
"jupyter>=1.1.1",
"jupytext>=1.17.2",
"pandas>=2.2.3",
"polars>=1.17.1",
"seaborn>=0.13.2",
]


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

[tool.ruff]
line-length = 88
fix = true
# Assume Python 3.11
target-version = "py311"
# Assume Python 3.12
target-version = "py312"

[tool.ruff.lint]
# docs: https://docs.astral.sh/ruff/rules/
Expand Down Expand Up @@ -59,8 +65,7 @@ ignore = [
docstring-code-format = true
docstring-code-line-length = 88

[tool.mdformat]
# docs: https://mdformat.readthedocs.io/en/stable/users/configuration_file.html
wrap = 88 # possible values: {"keep", "no", INTEGER}
number = false # possible values: {false, true}
end_of_line = "lf" # possible values: {"lf", "crlf", "keep"}
[tool.codespell]
builtin = "clear,rare,informal,usage,code,names"
ignore-words-list = "jupyter,ipa"
skip = "uv.lock"
Loading