pypa/pipenvNew scan
93/ 100 · A

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

Python Development Workflow for Humans.

Python25,069 starsMITupdated 8d ago
DocumentationREADME, setup, examples, license
83
EngineeringTests, CI, linting, lockfiles
98
Project healthDescription, activity, stars, deps
96

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
    DocumentationInfo

    Show a quick-start snippet so contributors can see what using your project looks like.

Detailed breakdown

Documentation

83
  • README85
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • 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 guide45
    • CONTRIBUTING guide is very brief (0 pts for depth); 150+ words earns +6 pts, 400+ earns +12 pts.Add setup instructions, code style notes, and how to run tests.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide lacks a testing section (−8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    • Contributing guide lacks a PR workflow section (−8 pts).Explain how to fork, branch, and open a pull request so contributors know what to expect.
    • Contributing guide has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • 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

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

    Not applicable?

    • CI is configured (.github/workflows/ci.yaml).
    • 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 tests across multiple environments or versions.
  • Linting and formatting100
    • Linter or formatter configured (.editorconfig).
    • pyproject.toml configures both a formatter/linter (ruff/black) and type checking (mypy).
  • Reproducibility80
    • Lockfile present (Pipfile.lock). Installs are reproducible.
    • Environment pinned via docker/Dockerfile.
    • 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 (Pipfile).
    • 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).
    • 25,069 stars.
  • Housekeeping100
    • .gitignore present.
Repository files33 root entries
  • .github
    Info: CONTRIBUTING guide is very brief (0 pts for depth); 150+ words earns +6 pts, 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Info: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Info: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Info: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
    Good: CI is configured (.github/workflows/ci.yaml).
    Good: Issue or PR templates present.
  • benchmarks
  • docker
    Good: Environment pinned via docker/Dockerfile.
  • docs
  • examples
  • news
  • pipenv
  • tasks
  • tests
    Good: Test files detected (tests).
  • .deepsource.toml
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • get-pipenv.py
  • HISTORY.txt
  • LICENSE
    Good: Licensed under MIT.
  • Makefile
  • MANIFEST.in
  • NOTICES
  • Pipfile
    Good: Dependency manifest found (Pipfile).
  • Pipfile.lock
    Good: Lockfile present (Pipfile.lock). Installs are reproducible.
  • pylock.toml
  • 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.
    Info: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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
  • run-tests.bat
  • run-tests.sh
  • SECURITY.md
    Good: Security policy present.