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

Add asset installation to nbreport's report instantiation

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:

      Description

      nbreport users would like to include assets alongside the templated notebook, and have those assets copied into place when the report is instantiated. These assets might be Python modules that the notebook imports. Or it might be image files or general data files, or a directory tree full of data files.

      nbreport can support this by adding a configuration key to the nbreport.yaml file format. The copy-on-instantiation feature should replicate any directory structure of these assets relative to the notebook.

        Attachments

          Activity

          Show
          jsick Jonathan Sick added a comment - Released as nbreport==0.7.3 on PyPI. The docs for this feature are at: https://nbreport.lsst.io/repository-guide/how-to-include-data-files-as-assets.html https://nbreport.lsst.io/repository-guide/how-to-use-python-modules.html https://nbreport.lsst.io/repository-guide/nbreport-yaml-reference.html

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel