psf/requestsNew scan
93/ 100 · A

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

A simple, yet elegant, HTTP library.

Python54,045 starsApache-2.0updated 2d ago
DocumentationREADME, setup, examples, license
94
EngineeringTests, CI, linting, lockfiles
91
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringIssue

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    Install and run instructions
    DocumentationIssue

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

Detailed breakdown

Documentation

94
  • 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 Apache-2.0.
  • Contributing guide77
    • 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.
    • Code of conduct present.

Engineering

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

    Not applicable?

    • CI is configured (.github/workflows/lint.yml).
    • The CI workflow does not appear to run any tests (−28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • 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 ([tool.ruff] / [tool.black] in pyproject.toml).
  • Reproducibility90
    • 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.
    • Dependabot covers 2 ecosystems (github-actions, pre-commit). Dependencies stay current.
  • 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: Python.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 54,045 stars.
  • Housekeeping100
    • .gitignore present.
Repository files21 root entries
  • .github
    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.
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, pre-commit). Dependencies stay current.
    Good: Issue or PR templates present.
    Good: Security policy present.
  • docs
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
  • ext
  • src
  • tests
    Good: Test files detected (tests).
  • .coveragerc
  • .git-blame-ignore-revs
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • AUTHORS.rst
  • HISTORY.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • MANIFEST.in
  • NOTICE
  • 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.
  • requirements-dev.txt
  • setup.py
  • tox.ini