gridfm/gridfm-datakit
Grade a repo

0

/ 100

GradeC

Good shape overall. A few tweaks would push it into the top tier.

Top 33% of 5,156 graded repos

Generate power flow data to train machine learning and foundation models for the electric power grid.

Documentation97
Engineering60
Health98
Python121Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

  4. 4
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

97

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt99

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

60

Linting and formatting5pt0

No linter or formatter configured.

→ Add [tool.ruff] to pyproject.toml. Ruff handles linting and formatting in one tool and replaces flake8, isort, and black.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Tests18pt85

Test files detected (scripts/notebooks/development/test_load_partitions.py).

CI/CD14pt100

CI is configured (.github/workflows/ci-build.yaml).

Project health

98

Dependency manifest6pt93

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 23
    Forks
  • 16
    Releaseslatest 11mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 121
    Watchers

Responsiveness

  • 42d 9h
    Median issue response
  • 2h
    Median PR merge time
  • 9
    Open issues
Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/ci-build.yaml).
  • docs
  • gridfm_datakit
  • opf_data
  • pfdelta
  • scripts
    Good: Test files detected (scripts/notebooks/development/test_load_partitions.py).
  • tests
  • .coverage
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .secrets.baseline
  • .whitesource
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • COMMITTERS.csv
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • coveragerc
  • feature-proposal.md
  • GOVERNANCE.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • MANIFEST.in
  • mkdocs.yml
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • RELEASE.md
  • SECURITY.md
    Good: Security policy present.
  • SUPPORT.md
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/gridfm/gridfm-datakit)](https://www.repo-grade.com/report/gridfm/gridfm-datakit)

More graded Python repos