Skip to content

Commit 409e073

Browse files
authored
make clear that the recommended approach is dev installing
1 parent c3c1ff7 commit 409e073

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

source/discussions/src-layout-vs-flat-layout.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,10 @@ Running a command-line interface from source with src-layout
8888
Due to the firstly mentioned specialty of the src layout, a command-line
8989
interface can not be run directly from the :term:`source tree <Project Source Tree>`.
9090

91-
To run a command-line interface directly, you can either:
91+
To run a command-line interface directly, you can install the package in
92+
:doc:`Development Mode <setuptools:userguide/development_mode>` for testing purposes.
93+
94+
Since this can be unpractical in some situations, you can also either:
9295

9396
Run :file:`__main__.py` via:
9497

@@ -97,10 +100,8 @@ Run :file:`__main__.py` via:
97100
cd src/
98101
python -m awesome_package
99102
100-
Or install the package in :doc:`Development Mode <setuptools:userguide/development_mode>`
101-
for testing purposes. Since this can be unpractical in some situations,
102-
a workaround could be to prepend the package folder to Python's
103-
:py:data:`sys.path` when called via its :file:`__main__.py` file:
103+
Or prepend the package folder to Python's :py:data:`sys.path` when called via its
104+
:file:`__main__.py` file:
104105

105106
.. code-block:: python
106107

0 commit comments

Comments
 (0)