Project structure

Refs

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

Default project structure (NOT including opt-ins)

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

Open questions

• No setup.py?
• What should we do about setup.cfg?
• How to include license file in wheels?
• Where do data files (eg. images) lie? How to include them?