kikidesign/setuptools

0

/ 100

Documentation40
Engineering74
Health75
Python09y ago
Grade a repo

Rough and inactive. Tests, CI, and a fuller README would revive it.

Official project repository for the Setuptools build system

Documentation

40

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt40

README is present.

Install and run instructions9pt90

README documents how to install the project.

Engineering

74

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Issue and PR templates6pt0

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.

Reproducibility6pt70

Lockfile present (docs/requirements.txt). Installs are reproducible.

Tests18pt100

Test files detected (conftest.py).

CI/CD14pt100

CI is configured (.travis.yml).

Project health

75

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Dependency manifest6pt100

Dependency manifest found (setup.cfg).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 0
    Watchers

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files21 root entries
  • docs
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
  • pkg_resources
  • setuptools
  • tests
  • .gitignore
    Good: .gitignore present.
  • .hgignore
  • .hgtags
  • .travis.yml
    Good: CI is configured (.travis.yml).
  • bootstrap.py
  • CHANGES.rst
  • conftest.py
    Good: Test files detected (conftest.py).
  • easy_install.py
  • launcher.c
  • MANIFEST.in
  • msvc-build-launcher.cmd
  • pavement.py
  • pytest.ini
  • README.rst
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: 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.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • setup.cfg
    Good: Dependency manifest found (setup.cfg).
  • setup.py
  • tox.ini