neurodatawithoutborders/pynwb

0

/ 100

Documentation72
Engineering90
Health100
Python218Other1d ago
Grade a repo

Polished and well engineered. Punching above its star count.

A Python API for working with Neurodata stored in the NWB Format

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 Other.

Engineering

90

Reproducibility6pt70

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

CI/CD14pt85

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

Tests18pt95

Test files detected (tests).

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

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)
  • 94
    Forks
  • 48
    Releaseslatest 7y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 218
    Watchers

Responsiveness

  • 63d 20h
    Median issue response
  • <1h
    Median PR merge time
  • 273
    Open issues
Repository files23 root entries
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/check_sphinx_links.yml).
    Good: Issue or PR templates present.
  • docs
    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.
    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.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • .codecov.yml
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .readthedocs.yaml
  • CHANGELOG.md
  • environment-ros3.yml
  • Legal.txt
  • license.txt
    Good: Licensed under Other.
  • 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.
  • requirements-dev.txt
  • requirements-doc.txt
  • requirements-min.txt
  • requirements-opt.txt
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
  • test.py
  • tox.ini