Skip to content

Switch to src/ layout? #826

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.

Sign up for GitHub

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

Jump to bottom
Closed
obestwalter opened this issue May 17, 2018 · 5 comments
Closed

Switch to src/ layout? #826

obestwalter opened this issue May 17, 2018 · 5 comments
Labels
needs:discussion It's not quite clear if and how this should be done type:internal should have no impact on the user (refactoring, infrastructure, tools, etc.)

Comments

@obestwalter
Copy link
Member

obestwalter commented May 17, 2018 •
edited
Loading

While we are in tidy up mode: How about switching the project to src/ layout (pypa/packaging.python.org#320 - especially: pypa/packaging.python.org#320 (comment)) - we have that kind of layout.

Apart from avoiding potential gotchas, this would make it trivial to run the tests of a checkout against a diffferent version of tox that is installed.
@obestwalter obestwalter added needs:discussion It's not quite clear if and how this should be done type:internal should have no impact on the user (refactoring, infrastructure, tools, etc.) labels May 17, 2018
@gaborbernat
Copy link
Member

Yeah definitely this needs to happen.

@pradyunsg
Copy link

Yep. Definitely a good idea.

@nicoddemus nicoddemus mentioned this issue May 18, 2018
Closed
@obestwalter
Copy link
Member Author

obestwalter commented May 25, 2018 •
edited
Loading

Some additional remarks on this, even when I seem to have pushed at an open door with this proposal here.

I think using this layout specifically in the context of projects using pytest and/or tox should be generally recommended. The reasoning behind this is layed out very well here in the pytest docs. Now, if you actually are pytest or tox and therefore testing yourself with yourself (how wonderfully meta is that?), this should be the obvious layout choice.

Also: the vision of tox is to support and promote good testing and packaging practices, so the way how the project itself is structured should follow its own advice.

gaborbernat added a commit that referenced this issue Jun 11, 2018
@gaborbernat
[#826] switch to source layout (#827)
4e7d909 
* move to src layout
* fix coverage
* PR feedback
@gaborbernat
Copy link
Member

@obestwalter this is now fixed

@obestwalter
Copy link
Member Author

Thanks @gaborbernat!

@tox-dev tox-dev locked and limited conversation to collaborators Jan 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
needs:discussion It's not quite clear if and how this should be done type:internal should have no impact on the user (refactoring, infrastructure, tools, etc.)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@obestwalter @gaborbernat @pradyunsg