zarr-developers/zarr-pythonNew scan
94/ 100 · A

A well-known project done right. Strong docs and solid engineering throughout.

An implementation of chunked, compressed, N-dimensional arrays for Python.

Python1,999 starsMITupdated 1d ago
DocumentationREADME, setup, examples, license
88
EngineeringTests, CI, linting, lockfiles
96
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringIssue

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    README
    DocumentationIssue

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

Detailed breakdown

Documentation

88
  • README80
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • No .env.example found (−10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide92
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Optional: add a Code of Conduct.A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

96
  • Tests100
    • Test files detected (packages/zarr-metadata/tests).
    • Pytest is fully configured in pyproject.toml with testpaths and test files detected.
    • Coverage reporting is configured in pyproject.toml.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/check_changelogs.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not run a lint or format check (−15 pts).Add a lint step to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).
  • Reproducibility100
    • Lockfile present (uv.lock). Installs are reproducible.
    • Environment pinned via .python-version.
    • Dependabot covers 3 ecosystems (github-actions, uv, github-actions). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (pyproject.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
    • pyproject.toml has a [build-system] table. The package can be built and published.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Python.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 1,999 stars.
  • Housekeeping100
    • .gitignore present.
Repository files26 root entries
  • .github
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    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.
    Good: Contributing guide includes code examples.
    Good: CI is configured (.github/workflows/check_changelogs.yml).
    Good: Dependabot covers 3 ecosystems (github-actions, uv, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • bench
  • changes
  • ci
  • design
  • docs
  • examples
  • packages
    Good: Test files detected (packages/zarr-metadata/tests).
  • src
  • tests
  • .git_archival.txt
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .python-version
    Good: Environment pinned via .python-version.
  • .pyup.yml
  • .readthedocs.yaml
  • codecov.yml
  • FUNDING.yml
  • LICENSE.txt
    Good: Licensed under MIT.
  • mkdocs.yml
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    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.
  • TEAM.md
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.