Uploaded image for project: 'Request For Comments'
  1. Request For Comments
  2. RFC-684

Add Click package as lsst_distrib dependency through daf_butler

    XMLWordPrintable

    Details

    • Type: RFC
    • Status: Implemented
    • Resolution: Done
    • Component/s: DM
    • Labels:
      None

      Description

      We are developing butler gen3 command line tools and to ensure consistency we wish to adopt the git style of using subcommands, supporting a single top-level command that takes subcommands with arguments for common operations (e.g. listing collections or registering instruments). To simplify the coding for this we would like to use the python Click package.

      Click is already part of our conda environment through an indirect dependency but we would like to make the dependency explicit and allow daf_butler to use it. I would like to do this by adding it to the base conda environment (where it is already).

      It is our understanding that click is already in use outside of science pipelines and that sphinx support for documenting these subcommands has already been tested by the SQuaRE team.

        Attachments

          Issue Links

            Activity

            Hide
            ktl Kian-Tat Lim added a comment -

            Show
            ktl Kian-Tat Lim added a comment -
            Hide
            swinbank John Swinbank added a comment - - edited

            With apologies for naïvety — what does this mean in practice?

            Are you suggesting that we add an EUPS package of Click and have daf_butler depend on that? Would that package actually contain Click, or would it be a shim (like Numpy, Scipy, etc)?

            Or is there some mechanism that I'm not aware of (or have embarrassingly forgotten) for packages to declare an explicit dependency on specific parts of the Conda environment?

            Show
            swinbank John Swinbank added a comment - - edited With apologies for naïvety — what does this mean in practice? Are you suggesting that we add an EUPS package of Click and have daf_butler depend on that? Would that package actually contain Click, or would it be a shim (like Numpy, Scipy, etc)? Or is there some mechanism that I'm not aware of (or have embarrassingly forgotten) for packages to declare an explicit dependency on specific parts of the Conda environment?
            Hide
            tjenness Tim Jenness added a comment -

            I'm not wanting eups to be involved at all. When the new conda-forge world turns up imminently we will no longer have eups involved for thirdparty packages and won't have shims either. This would be just the same as pyarrow or pytest at the moment. We declare that click is part of the scipipe_conda_env bleed list as a prerequisite.

            Show
            tjenness Tim Jenness added a comment - I'm not wanting eups to be involved at all. When the new conda-forge world turns up imminently we will no longer have eups involved for thirdparty packages and won't have shims either. This would be just the same as pyarrow or pytest at the moment. We declare that click is part of the scipipe_conda_env bleed list as a prerequisite.
            Hide
            swinbank John Swinbank added a comment -

            Understood; thanks. Fine by me.

            Show
            swinbank John Swinbank added a comment - Understood; thanks. Fine by me.
            Hide
            npease Nate Pease added a comment -

            No objections, CCB indicated they thought this is ok; adopting.

            Show
            npease Nate Pease added a comment - No objections, CCB indicated they thought this is ok; adopting.
            Hide
            jsick Jonathan Sick added a comment -

            In DM-24411 I've released Documenteer 0.5.8. This adds sphinx_click.ext to the default Sphinx extensions list for all Science Pipelines documentation projects (that use the documenteer.sphinxconfig.stackconf configuration module).

            Show
            jsick Jonathan Sick added a comment - In DM-24411 I've released Documenteer 0.5.8. This adds sphinx_click.ext to the default Sphinx extensions list for all Science Pipelines documentation projects (that use the documenteer.sphinxconfig.stackconf configuration module).

              People

              Assignee:
              tjenness Tim Jenness
              Reporter:
              tjenness Tim Jenness
              Watchers:
              Andy Salnikov, Jim Bosch, John Swinbank, Jonathan Sick, Kian-Tat Lim, Michelle Gower, Nate Pease, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Planned End: