PyCQA/isortNew scan
91/ 100 · A

A well-known project done right. Strong docs and solid engineering throughout.

A Python utility / library to sort imports.

Python6,947 starsMITupdated 2d ago
DocumentationREADME, setup, examples, license
93
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
    Install and run instructions
    DocumentationIssue

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

  3. 3
    Reproducibility
    EngineeringIssue

    Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.

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.
    • No .env.example found (−10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide72
    • CONTRIBUTING guide found.
    • CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    • Optional: add a Code of Conduct.A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

87
  • Tests100
    • Test files detected (tests).
    • 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/continuous-integration.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.
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • Linter or formatter configured (.editorconfig).
  • Reproducibility92
    • Lockfile present (uv.lock). Installs are reproducible.
    • Environment pinned via Dockerfile.
    • Consider using a multi-stage Dockerfile (builder + runtime stage) for smaller, more secure images.Use a multi-stage Dockerfile.
    • Dependabot configured for github-actions.
    • Dependabot only covers one ecosystem (−8 pts). Covering 2+ ecosystems earns the full +20 pts.Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • Issue and PR templates0
    • No issue or PR templates found (−100 pts).Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

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).
    • 6,947 stars.
  • Housekeeping100
    • .gitignore present.
Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/continuous-integration.yml).
    Good: Dependabot configured for github-actions.
  • art
  • docs
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
  • example_isort_formatting_plugin
  • example_isort_sorting_plugin
  • example_shared_isort_profile
  • isort
  • scripts
  • tests
    Good: Test files detected (tests).
  • .codecov.yml
  • .cruft.json
  • .deepsource.toml
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .pre-commit-hooks.yaml
  • .readthedocs.yaml
  • CHANGELOG.md
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • example.gif
  • LICENSE
    Good: Licensed under MIT.
  • logo.png
  • 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.
  • tox.ini
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.