python-humanize/humanizeNew scan
90/ 100 · A

Polished and well engineered. Punching above its star count.

Python humanize functions

Python733 starsMITupdated 7d ago
DocumentationREADME, setup, examples, license
93
EngineeringTests, CI, linting, lockfiles
87
Project healthDescription, activity, stars, deps
96

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  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 MIT.
  • Contributing guide70
    • CONTRIBUTING guide or docs directory present.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

87
  • Tests85
    • Test files detected (tests).
    • Pytest referenced in pyproject.toml and test files present.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/lint.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • pyproject.toml configures both a formatter/linter (ruff/black) and type checking (mypy).
  • Reproducibility70
    • Lockfile present (docs/requirements.txt). 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

96
  • 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 metadata85
    • Repository has a description.
    • Primary language detected: Python.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 733 stars.
  • Housekeeping100
    • .gitignore present.
Repository files16 root entries
  • .github
    Good: CONTRIBUTING guide or docs directory present.
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • docs
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yml
  • .yamlfmt.yaml
  • LICENCE
    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.
    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.
  • RELEASING.md
  • requirements-mypy.txt
  • tox.ini