Skip to content

Commit

Permalink
make clear that the recommended approach is dev installing
Browse files Browse the repository at this point in the history
  • Loading branch information
ekohilas committed Nov 25, 2024
1 parent bc6377c commit 0ad91e0
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions source/discussions/src-layout-vs-flat-layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ Running a command-line interface from source with src-layout
Due to the firstly mentioned specialty of the src layout, a command-line
interface can not be run directly from the :term:`source tree <Project Source Tree>`.

To run a command-line interface directly, you can either:
To run a command-line interface directly, you can install the package in
:doc:`Development Mode <setuptools:userguide/development_mode>` for testing purposes.

Since this can be unpractical in some situations, you can also either:

Run :file:`__main__.py` via:

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

.. code-block:: python
Expand Down

0 comments on commit 0ad91e0

Please sign in to comment.