bokeh/bokehNew scan
96/ 100 · A

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

Interactive Data Visualization in the browser, from Python

TypeScript20,403 starsBSD-3-Clauseupdated 4d ago

Outstanding work. A score of 96/100 puts this repo in a very small tier of truly well-engineered open source projects.

DocumentationREADME, setup, examples, license
93
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
    EngineeringInfo

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

  2. 2
    Install and run instructions
    DocumentationInfo

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

  3. 3
    Reproducibility
    EngineeringInfo

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

Detailed breakdown

Documentation

93
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • 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 BSD-3-Clause.
  • Contributing guide75
    • CONTRIBUTING guide or docs directory present.
    • Code of conduct present.

Engineering

96
  • Tests100
    • Test files detected (bokehjs/test).
    • Pytest configured via [tool.pytest.ini_options] in pyproject.toml with test files present.
    • Coverage reporting is configured in pyproject.toml.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/bokeh-ci-full.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • Linter or formatter configured (bokehjs/eslint.config.mjs).
    • pyproject.toml configures both a formatter/linter (ruff/black) and type checking (mypy).
  • Reproducibility70
    • Lockfile present (bokehjs/package-lock.json). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • 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: TypeScript.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 20,403 stars.
  • Housekeeping100
    • .gitignore present.
Repository files17 root entries
  • .github
    Good: CONTRIBUTING guide or docs directory present.
    Good: CI is configured (.github/workflows/bokeh-ci-full.yml).
    Good: Issue or PR templates present.
  • bokehjs
    Good: Test files detected (bokehjs/test).
    Good: Linter or formatter configured (bokehjs/eslint.config.mjs).
    Good: Lockfile present (bokehjs/package-lock.json). Installs are reproducible.
  • conda
  • docs
    Good: Code of conduct present.
    Good: Security policy present.
  • examples
  • release
  • scripts
  • src
  • tests
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • LICENSE.txt
    Good: Licensed under BSD-3-Clause.
  • MANIFEST.in
  • 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.
  • setup.py