Python Package Structure

[g4brielvs]

Within the (fabulously chaotic) Python packaging ecosystem, you'll typically encounter two main project structures: the src layout and the flat layout. Each of these layouts have advantages and disadvantages.

There is increasing consensus to adopt the src/ layout, for instance:

• The src layout helps prevent accidental usage of the in-development copy of the code. Using a src layout ensures that tests run against the installed version of the package (the one that would be installed by pip), rather than the local source code.

• The src layout helps enforce that an editable installation is only able to import files that were meant to be importable.

• Several World Bank projects use the src layout, e.g., BlackMarblePy, GOSTnets and the Template.

But now, it is your turn. What are your thoughts on this topic? (And the following meme).

[g4brielvs]

@elbeejay Thank you for bringing up worldbank/GOSTnets#55 regarding the structure of a project. This discussion is relevant on that topic.

[elbeejay]

I'm fine with the src/ layout, my curiousity in the linked issue was related to the pyproject.toml build, which locally (for me at least), created it's own "flat" layout and stuck the automatically generated _version.py file there.

It makes me think pyproject.toml is expecting the flat layout, maybe there's a way to tell it we're using the src layout...

Edit: looking at the "last modified" dates I'm wondering if my "flat" appearing folder structure is from before you created the src/ directory @g4brielvs