plotly/plotly.pyNew scan
91/ 100 · A

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

The interactive graphing library for Python :sparkles:

Python18,601 starsMITupdated 13d ago
DocumentationREADME, setup, examples, license
90
EngineeringTests, CI, linting, lockfiles
87
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

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

  2. 2
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  3. 3
    README
    DocumentationWarning

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

Detailed breakdown

Documentation

90
  • 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.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide100
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

87
  • Tests100
    • Test files detected (plotly/matplotlylib/mplexporter/tests).
    • Pytest configured via [tool.pytest.ini_options] in pyproject.toml with test files present.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/build-doc.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI includes a build step.
  • Linting and formatting0
    • No linter or type checker configured in pyproject.toml (−80 pts).Add [tool.ruff] for linting and [tool.mypy] for type checking to pyproject.toml.
    • No linter or formatter config found.Add ESLint, Prettier, Ruff, or similar. Consistent style lowers the barrier for contributors.
  • Reproducibility80
    • Lockfile present (uv.lock). Installs are reproducible.
    • Environment pinned via environment.yml.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

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).
    • 18,601 stars.
  • Housekeeping100
    • .gitignore present.
Repository files24 root entries
  • _plotly_utils
  • .github
    Good: CI is configured (.github/workflows/build-doc.yml).
    Good: Issue or PR templates present.
  • codegen
  • doc
  • js
  • plotly
    Good: Test files detected (plotly/matplotlylib/mplexporter/tests).
  • templategen
  • test_init
  • tests
  • .gitignore
    Good: .gitignore present.
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CITATION.cff
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • commands.py
  • CONTRIBUTING.md
  • dependabot.yml
  • environment.yml
    Good: Environment pinned via environment.yml.
  • LICENSE.txt
    Good: Licensed under MIT.
  • MIGRATION_GUIDE.md
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: 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.
  • RELEASE.md
  • SECURITY.md
    Good: Security policy present.
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.