Add pip install -e to conda env descriptions

This automatically installs the package as part of environment creation. Thanks to Michael Dunphy for the tip that this is possible.
SalishSeaCast · Oct 11, 2022 · eef82d3 · eef82d3
1 parent 149a1b1
commit eef82d3
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 25 deletions.
diff --git a/.github/workflows/deployment.yaml b/.github/workflows/deployment.yaml
@@ -18,7 +18,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Set up conda environment
+      - name: Set up conda environment and install salishsea-site package
         uses: conda-incubator/setup-miniconda@v2
         with:
            miniforge-variant: Mambaforge-pypy3
@@ -32,11 +32,6 @@ jobs:
            environment-file: envs/environment-test.yaml
            activate-environment: salishsea-site-test
 
-      - name: Install package
-        shell: bash -l {0}
-        run: |
-          python3 -m pip install --editable $GITHUB_WORKSPACE
-
       - name: pytest package
         shell: bash -l {0}
         run: |

diff --git a/.github/workflows/docs-linkcheck.yaml b/.github/workflows/docs-linkcheck.yaml
@@ -20,7 +20,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Set up conda environment
+      - name: Set up conda environment and install salishsea-site package
         uses: conda-incubator/setup-miniconda@v2
         with:
            miniforge-variant: Mambaforge-pypy3
@@ -34,11 +34,6 @@ jobs:
            environment-file: envs/environment-test.yaml
            activate-environment: salishsea-site-test
 
-      - name: Install package
-        shell: bash -l {0}
-        run: |
-          python3 -m pip install --editable $GITHUB_WORKSPACE
-
       - name: linkcheck docs
         shell: bash -l {0}
         run: |

diff --git a/.github/workflows/pytest-coverage.yaml b/.github/workflows/pytest-coverage.yaml
@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Set up conda environment
+      - name: Set up conda environment and install salishsea-site package
         uses: conda-incubator/setup-miniconda@v2
         with:
            miniforge-variant: Mambaforge-pypy3
@@ -30,11 +30,6 @@ jobs:
            python-version: ${{ matrix.python-version }}
            activate-environment: salishsea-site-test
 
-      - name: Install package
-        shell: bash -l {0}
-        run: |
-          python3 -m pip install --editable $GITHUB_WORKSPACE
-
       - name: pytest package with coverage
         shell: bash -l {0}
         run: |

diff --git a/docs/index.rst b/docs/index.rst
@@ -213,10 +213,13 @@ and building the documentation with the commands:
 
     $ cd salishsea-site
     $ conda env create -f env/environment-dev.yaml
-    $ conda activate salishsea-site
-    (salishsea-site)$ python3 -m pip install --editable .
 
-The :kbd:`--editable` option in the :command:`pip install` commands above installs the :kbd:`salishsea-site` package via a symlink so that it is automatically updated as the repo evolves.
+The :kbd:`salishsea-site` package is installed in `editable install mode`_
+as part of the conda environment creation process.
+That means that the package is installed from the cloned repo via symlinks so that
+it will be automatically updated as the repo evolves.
+
+.. _editable install mode: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
 
 To deactivate the environment use:
 

diff --git a/envs/environment-dev.yaml b/envs/environment-dev.yaml
@@ -6,8 +6,6 @@
 #
 #    $ cd salishsea_site
 #    $ conda env create -f envs/environment-dev.yaml
-#    $ source activate salishsea-site
-#    (salishsea-site)$ python3 -m pip install --editable .
 
 name: salishsea-site
 
@@ -42,3 +40,6 @@ dependencies:
     - sentry-sdk
     - supervisor
     - waitress
+
+    # editable install of salishsea-site package
+    - --editable ../
diff --git a/envs/environment-prod.yaml b/envs/environment-prod.yaml
@@ -6,8 +6,6 @@
 #
 #    $ cd salishsea_site
 #    $ conda env create -f envs/environment-prod.yaml
-#    $ source activate salishsea-site
-#    (salishsea-site)$ python3 -m pip install --editable .
 
 name: salishsea-site-env
 
@@ -28,3 +26,6 @@ dependencies:
     - sentry-sdk
     - supervisor
     - waitress
+
+    # editable install of salishsea-site package
+    - --editable ../
diff --git a/envs/environment-test.yaml b/envs/environment-test.yaml
@@ -33,3 +33,6 @@ dependencies:
     - sentry-sdk
     - supervisor
     - waitress
+
+    # editable install of salishsea-site package
+    - --editable ../