Skip to content

Commit 15ca868

Browse files
committed
Docs: finetune "dev install on windows"
1 parent 522d70a commit 15ca868

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

docs/development.rst

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -360,31 +360,34 @@ Normally you can install the client the same way on Windows as on Linux, like so
360360
361361
pip install -e .[dev]
362362
363-
This should be working with the most recent code, however, in the past we sometimes had issues with a development installation.
363+
Alternative development installation
364+
-------------------------------------
364365

365-
Should you experience problems, there is also a conda package for the Python client and that should be the easiest solution.
366+
The standard pure-``pip`` based installation should work with the most recent code.
367+
However, in the past we sometimes had issues with this procedure.
368+
Should you experience problems, consider using an alternative conda-based installation procedure:
366369

367-
For development, what you need to do is:
370+
1. Create and activate a new conda environment for developing the openeo-python-client.
371+
For example:
368372

369-
1. Create and activate a new conda environment for developing the openeo-python-client.
370-
2. In that conda environment, install only the dependencies of openeo via conda, but not the openeo package itself.
371-
3. Do a pip install of the code in *editable mode* with `pip -e`.
373+
.. code-block:: console
372374
373-
.. code-block:: console
375+
conda create -n openeopyclient
376+
conda activate openeopyclient
377+
378+
2. In that conda environment, install only the dependencies of ``openeo`` via conda,
379+
but not the ``openeo`` package itself.
374380

375-
conda create -n <your environment's name>
381+
.. code-block:: console
376382
377-
# For example:
378-
conda create -n openeopyclient
383+
# Install openeo dependencies (from the conda-forge channel)
384+
conda install --only-deps -c conda-forge openeo
379385
380-
# Activate the conda environment
381-
conda activate openeopyclient
386+
3. Do a ``pip install`` from the project root in *editable mode* (``pip -e``):
382387

383-
# Install openeo from the conda-forge channel
384-
conda install --only-deps -c conda-forge openeo
388+
.. code-block:: console
385389
386-
# Now install the openeo code in editable mode.
387-
pip install -e .[dev]
390+
pip install -e .[dev]
388391
389392
390393

0 commit comments

Comments
 (0)