Python Project Conventions

Project conventions for install, lint, test, format, and coverage via Make Use when this capability is needed.

tomevault-io 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

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/rcarmo--agentbox--python commit d2c9490168

Frequently asked questions

npx skillmds@latest add tomevault-io/python-project-conventions