Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Why no 'src' directory? #1

Closed
inklesspen opened this issue May 25, 2023 · 2 comments
Closed

Why no 'src' directory? #1

inklesspen opened this issue May 25, 2023 · 2 comments

Comments

@inklesspen
Copy link

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
Copy link
Owner

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.).

@pyrustic
Copy link
Owner

I have updated the tool and now a new project generated with it will include have the src directory. Moving from the flat layout to the src directory fixed a package discoverability issue in my IDE. Several of my projects aren't anymore following the flat layout !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants