camurban/pterasoftware
Grade a repo

0

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 14% of 5,156 graded repos

Ptera Software is a fast, easy-to-use, and open-source software package for analyzing flapping-wing flight.

Documentation97
Engineering87
Health82
Python249MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

12 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
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

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

  4. 4
    Install and run instructions9pt

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

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 guide5pt97

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

87

CI/CD14pt72

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

Tests18pt90

Test files detected (tests).

Reproducibility6pt90

Lockfile present (requirements.txt). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

82

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt62

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 63
    Forks
  • 32
    Releaseslatest 5y ago

Community

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

Responsiveness

  • 3d 17h
    Median issue response
  • <1h
    Median PR merge time
  • 36
    Open issues
Repository files32 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, pre-commit). Dependencies stay current.
    Good: Issue or PR templates present.
  • .idea
    Issue: Build artifacts or local files may be committed (.idea/.gitignore) (−40 pts).Fix: Remove them and add to .gitignore.
  • docs
  • examples
  • gui
  • pterasoftware
  • scripts
  • tests
    Good: Test files detected (tests).
  • validation
  • .codespell-ignore.txt
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • BUILD.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    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.
    Good: Contributing guide includes code examples.
  • LICENSE.md
    Good: Licensed under MIT.
  • make_installer.iss
  • MANIFEST.in
  • mypy.ini
  • pterasoftware.spec
  • 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.
  • requirements_dev.txt
  • requirements_min.txt
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
  • SECURITY.md
    Good: Security policy present.
  • setup.cfg
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/camurban/pterasoftware)](https://www.repo-grade.com/report/camurban/pterasoftware)

More graded Python repos