astropy/photutils
Grade a repo

78

/ 100

GradeC

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

Top 35% of 5,156 graded repos

Astropy package for source detection and photometry. Maintainer: @larrybradley

Documentation72
Engineering73
Health100
Python302BSD-3-Clause1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

15 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  4. 4
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

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

72

README12pt40

README is present.

Contributing guide5pt80

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under BSD-3-Clause.

Engineering

73

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.

Reproducibility6pt12

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.

CI/CD14pt85

CI is configured (.github/workflows/check_changelog.yml).

Tests18pt100

Test files detected (photutils/aperture/tests).

Linting and formatting5pt100

Linter or formatter configured (.flake8).

Project health

100

Dependency manifest6pt100

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)
  • 153
    Forks
  • 34
    Releaseslatest 6y ago

Community

  • 62% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 302
    Watchers

Responsiveness

  • 3d 5h
    Median issue response
  • 4d 2h
    Median PR merge time
  • 36
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/check_changelog.yml).
    Good: Dependabot configured for github-actions.
  • docs
  • photutils
    Good: Test files detected (photutils/aperture/tests).
  • scripts
  • .flake8
    Good: Linter or formatter configured (.flake8).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .pycodestyle
  • .readthedocs.yaml
  • CHANGES.rst
  • CITATION.cff
  • CODE_OF_CONDUCT.rst
    Good: Code of conduct present.
  • codecov.yml
  • CONTRIBUTING.rst
    Good: Contributing guide is detailed and thorough.
    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.
    Good: Contributing guide explains how to run tests.
    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.
  • LICENSE.rst
    Good: Licensed under BSD-3-Clause.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.rst
    Good: README is present.
    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.
    Good: README links to a live demo or deployed app.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tox.ini
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/astropy/photutils)](https://www.repo-grade.com/report/astropy/photutils)

More graded Python repos