Project structure

Default project structure (NOT including opt-ins)

• project name/
  • .git/
  • .gitignore
  • LICENSE.txt
  • README.md
  • pyproject.toml contains build ([build-system]) and tools config
  • setup.cfg contains project-related data ([metadata], [options])
  • setup.py contains setuptools.setup() for editable installs
  • package name/
    • __init__.py
    • assets/
      • ... non-code files go here ...
    • ... package content goes here ...
  • tests/
    • __init__.py
    • ... tests go here ...
  • venv/
  • docs/ depends if we provide a doc generation tool as opt-out
    • ... documentation goes here ...

Refs

• Few infos from the PyPA
• More importantly, its exemple project