Textualize/richNew scan
96/ 100 · A

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

Rich is a Python library for rich text and beautiful formatting in the terminal.

Python56,623 starsMITupdated 2mo 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
97
EngineeringTests, CI, linting, lockfiles
96
Project healthDescription, activity, stars, deps
95

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Install and run instructions
    DocumentationInfo

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

  2. 2
    Reproducibility
    EngineeringInfo

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

  3. 3
    Linting and formatting
    EngineeringInfo

    Add [tool.ruff] or [tool.black] to pyproject.toml for code formatting.

Detailed breakdown

Documentation

97
  • 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 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

96
  • Tests100
    • Test files detected (tests).
    • Pytest is fully configured in pyproject.toml with testpaths and test files detected.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/pythonpackage.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.).
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
  • Linting and formatting75
    • pyproject.toml configures mypy type checking.
    • No ruff or black linter configured in pyproject.toml (−5 pts vs having both).Add [tool.ruff] or [tool.black] to pyproject.toml for code formatting.
  • Reproducibility90
    • Lockfile present (poetry.lock). 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.
    • Dependabot covers 2 ecosystems (pip, github-actions). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

95
  • 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).
  • Activity80
    • Actively maintained (pushed within 3 months).
    • 56,623 stars.
  • Housekeeping100
    • .gitignore present.
Repository files50 root entries
  • .faq
  • .github
    Good: CI is configured (.github/workflows/pythonpackage.yml).
    Good: Dependabot covers 2 ecosystems (pip, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • assets
  • benchmarks
  • docs
  • examples
  • imgs
  • questions
  • rich
  • tests
    Good: Test files detected (tests).
  • tools
  • .coveragerc
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yml
  • AI_POLICY.md
  • asv.conf.json
  • asvhashfile
  • 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.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • FAQ.md
  • faq.yml
  • LICENSE
    Good: Licensed under MIT.
  • make.bat
  • Makefile
  • poetry.lock
    Good: Lockfile present (poetry.lock). Installs are reproducible.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.cn.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.
  • README.de-ch.md
  • README.de.md
  • README.es.md
  • README.fa.md
  • README.fr.md
  • README.hi.md
  • README.id.md
  • README.it.md
  • README.ja.md
  • README.kr.md
  • README.md
  • README.pl.md
  • README.pt-br.md
  • README.ru.md
  • README.sv.md
  • README.tr.md
  • README.zh-tw.md
  • SECURITY.md
    Good: Security policy present.
  • setup.py
  • tox.ini