inovintell/py-template
Grade a repo

0

/ 100

GradeD

Getting some notice. Tests and CI would be the fastest wins.

One-click GitHub Actions pipelines for Python!

Documentation29
Engineering82
Health98
JavaScript93Apache-2.0today

Documentation

29

README12pt0

README is present.

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt66

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.

License6pt100

Licensed under Apache-2.0.

Engineering

82

CI/CD14pt57

CI is configured (.github/workflows/code-linter.yml).

Reproducibility6pt70

Lockfile present (poetry.lock). Installs are reproducible.

Tests18pt95

Test files detected (test).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

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)
  • 10
    Forks
  • 1
    Releaseslatest 3y ago

Community

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

Responsiveness

  • 3h
    Median issue response
  • 1h
    Median PR merge time
  • 6
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/code-linter.yml).
    Good: Issue or PR templates present.
  • docs
  • src
  • test
    Good: Test files detected (test).
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .yamllint.yml
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • commitlint.config.js
  • 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.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • cookiecutter.json
  • LICENSE.md
    Good: Licensed under Apache-2.0.
  • mkdocs.yml
  • poetry.lock
    Good: Lockfile present (poetry.lock). Installs are reproducible.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • renovate.json