Python project conventions

Project conventions for install, lint, test, format, and coverage via Make

rcarmo a4bc310 912 B Updated

File contents

Skill: Python project conventions

Goal

Provide a consistent Python dev experience (install/lint/test/format/coverage) via Make targets.

Expected repo files

  • pyproject.toml (preferred) or requirements*.txt
  • Package code under src/ (preferred) or top-level package dir
  • Tests under tests/

Make targets (recommended)

  • make installpython -m pip install -e .
  • make install-dev → install dev extras + ruff/pytest
  • make lintruff check ...
  • make formatruff format ...
  • make testpython -m pytest
  • make coveragepython -m pytest --cov=... --cov-report=term-missing
  • make checkmake lint && make coverage

Quality Bars

  • End product should be installable from the final repo URL via uv tool or pip

rcarmo/agentbox/tree/main/skel/.github/skills/python commit a4bc3109c3

Frequently asked questions

npx skillmds@latest add rcarmo/python-project-conventions