84/ 100 ยท B

Popular and well-maintained. A little polish away from elite status.

๐Ÿ’ซ Industrial-strength Natural Language Processing (NLP) in Python

Python33,658 starsMITupdated 28d ago
DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
78
Project healthDescription, activity, stars, deps
81

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

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

  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 .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

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 guide98
    • 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.
    • 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

78
  • Tests60
    • Test files detected (spacy/tests).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/cibuildwheel.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.).
    • 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 formatting60
    • Linter or formatter configured (website/.eslintrc).
  • Reproducibility80
    • Lockfile present (requirements.txt). Installs are reproducible.
    • Environment pinned via website/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 templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

81
  • Dependency manifest65
    • Dependency manifest found (pyproject.toml).
    • pyproject.toml has a [build-system] table. The package can be built and published.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Python.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 33,658 stars.
  • Housekeeping100
    • .gitignore present.
Repository files21 root entries
  • .github
    Good: CI is configured (.github/workflows/cibuildwheel.yml).
    Good: Issue or PR templates present.
  • bin
  • examples
  • extra
  • licenses
  • spacy
    Good: Test files detected (spacy/tests).
  • website
    Good: Linter or formatter configured (website/.eslintrc).
    Good: Environment pinned via website/Dockerfile.
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • build-constraints.txt
  • CITATION.cff
  • CONTRIBUTING.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.
  • LICENSE
    Good: Licensed under MIT.
  • Makefile
  • MANIFEST.in
  • netlify.toml
  • 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.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
  • setup.cfg
  • setup.py