CivicDataLab / CivicDataLab/IDS-DRR-Data-Management

Run ruff format and add to pre-commit

Open
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DPG
Dominant language
Python
Stars
1
Forks
0
Avg merge
1m
Merged PRs (30d)
1

Description

ruff format

  • Run ruff format
  • Create .git-blame-ignore-revs for the ruff format commit
  • Add id: ruff-format to .pre-commit-config.yaml

ruff check

  • Configure ruff check (below) and resolve TODO
  • Run ruff check --fix and ruff check --fix --unsafe-fixes
  • Work through ruff check --statistics or add to the TODO issue
  • Add - id: ruff-check to .pre-commit-config.yaml once ruff check succeeds

uv pip compile

  • Switch to requirements.in + requirements.txt
  • Configure pre-commit (can do once #74 and #73 are merged)
    • PR #84
ci:
  autoupdate_schedule: quarterly
  skip: [pip-compile]
# ...
  - repo: https://github.com/astral-sh/uv-pre-commit
    rev: 0.7.19
    hooks:
      - id: pip-compile
        name: pip-compile requirements.in
        args: [requirements.in, -o, requirements.txt]

Miscellaneous

  • Create layer/__init__.py to "fix: Add layer/__init__.py to explicitly mark the directory as a Python package"
  • Add automerge.yml workflow #72

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing .pre-commit-config.yaml and the existing Ruff configuration, then run ruff format across the repository. Create .git-blame-ignore-revs for the formatting commit and add the ruff-format hook; done means formatting is applied and the pre-commit configuration runs successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.