sgoldenlab/simba
Grade a repo

0

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 22% of 5,156 graded repos

SimBA (Simple Behavioral Analysis), a pipeline and GUI for developing supervised behavioral classifiers

Documentation86
Engineering80
Health94
Python362Other1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

6 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

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  4. 4
    Contributing guide5pt

    Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

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

86

Contributing guide5pt30

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Other.

Engineering

80

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Tests18pt80

Test files detected (tests).

Reproducibility6pt80

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

CI/CD14pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

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)
  • 179
    Forks
  • 2
    Releaseslatest 5y ago

Community

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

Responsiveness

  • 2h
    Median issue response
  • 3h
    Median PR merge time
  • 238
    Open issues
Repository files23 root entries
  • .fonts_poppins
  • .github
    Good: CI is configured (.github/workflows/tests_py310.yml).
    Good: Issue or PR templates present.
  • docs
    Good: Environment pinned via docs/environment.yml.
  • images
  • misc
  • scripts
  • simba
    Issue: Build artifacts or local files may be committed (simba/assets/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • tests
    Good: Test files detected (tests).
  • __init__.py
  • .gitignore
    Good: .gitignore present.
  • .pytest.ini
  • .readthedocs.yaml
  • App.py
  • CITATION.cff
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • LICENSE
    Good: Licensed under Other.
  • MANIFEST.in
  • 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_arm.txt
  • requirements_gpu.txt
  • requirements_wsl.txt
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • setup.py
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/sgoldenlab/simba)](https://www.repo-grade.com/report/sgoldenlab/simba)

More graded Python repos