Skip to content

Commit ccf5062

Browse files
committed
Add note about using src folder for packaging
1 parent 75d6b21 commit ccf5062

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/source/tutorial/packaging.rst

+9
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,15 @@ like.
322322
)
323323
324324
325+
.. note::
326+
327+
Ultimately, it is highly recommended to nest your source package root with a `src`
328+
directory. Doing so prevents a lot of common pitfalls you are likely to run into,
329+
as discussed on
330+
`good integration practices <https://docs.pytest.org/en/6.2.x/goodpractices.html>`_
331+
at pytest.org, which links to an excellent
332+
`blog post by Ionel Cristian Mărieș <https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure>`_.
333+
325334

326335
Installation
327336
^^^^^^^^^^^^

0 commit comments

Comments
 (0)