Skip to content

Python project checklist

The following files / directories are present

Mandatory

The presence of the following files is mandatory (assuming: this is a Python project, it uses Git as its SCM, etc.)

  • .git/
  • .gitignore
  • Makefile
  • README.md
  • noxfile.py (or tox.ini)
  • poetry.lock
  • pyproject.toml
  • ruff.toml
  • src/
  • setup.cfg
  • tests/

Note: this can be tested using [[Abilian DevTools]] (command adt cruft).

  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • DCO.txt
  • SECURITY.md

Optional

For heroku

  • Procfile
  • requirements.txt
  • runtime.txt

Page last modified: 2024-09-25 08:35:47