Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-5971

Make technote-bootstrap conda-friendly

    Details

      Description

      If someone runs pip install -r requirements.txt while running conda (either the default environment, or a custom environment, conda will tell pip to install those files in src/ of the current working directory. (Note: it doesn’t do this for regular pip install commands; only for pip install -r commands). The end result is that a user will unwittingly litter their technote’s directory and cause build errors.

      The solution is

      1. Ship a conda-compatible package list file (note that it can’t use pip’s tricks to install from GitHub as I currently do) with technote bootstrap
      2. Add instructions to the technote bootstrap’s README to conda create -n technote-env —file conda-reqs.txt and then source activate that environment when working on a technote.

        Attachments

          Issue Links

            Activity

            Hide
            ljones Lynne Jones added a comment -

            Will I have to make a technote environment? I don't actually use bash, so activating environments is a bit of a PITA. (unless someone has a way to do that from tcsh?)
            Presumably, I'd only have to make an environment if pyYaml, sphinx, documenteer or the lsst-dd-rtd-theme was going to conflict with something else in my conda environment?

            Show
            ljones Lynne Jones added a comment - Will I have to make a technote environment? I don't actually use bash, so activating environments is a bit of a PITA. (unless someone has a way to do that from tcsh?) Presumably, I'd only have to make an environment if pyYaml, sphinx, documenteer or the lsst-dd-rtd-theme was going to conflict with something else in my conda environment?
            Hide
            jsick Jonathan Sick added a comment -

            Made lsst-dd-rtd-theme pip installable; this will help make conda environment packaging easier.

            Show
            jsick Jonathan Sick added a comment - Made lsst-dd-rtd-theme pip installable; this will help make conda environment packaging easier.
            Hide
            jsick Jonathan Sick added a comment -

            With release 0.6, we are now distributing documenteer on conda-forge, so it might be possible to create a conda environment definition to go alongside the regular pip-based environment.

            Show
            jsick Jonathan Sick added a comment - With release 0.6, we are now distributing documenteer on conda-forge, so it might be possible to create a conda environment definition to go alongside the regular pip-based environment.

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Watchers:
                Jonathan Sick, Lynne Jones
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel