pyrustic / setupinit

Properly initialize a Python project
MIT License
1 stars 1 forks source link

Why no 'src' directory? #1

Open inklesspen opened 1 year ago

inklesspen commented 1 year ago

In the readme, you link to the Python Packaging User Guide and say this tool structures the package accordingly.

However, all the examples on that page have a src directory, following the best practice explained here. Why does this tool not do the same?

pyrustic commented 1 year ago

Hi ! Thank you for reporting this !

My README should have mentioned that the structure follows the flat-layout.

I've read a bit of some discussions related to the "src" directory (and also this one) and think it's worth doing some testing to see if I'll adopt this.

This package (setupinit) will be updated soon, I'm working on a big overhaul of the main repositories in this GitHub account, and I'm also thinking about a decent Git workflow to benefit from the contribution (better commit message with issue ref, branching, merging, etc.).