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

Create nbreport test command

    XMLWordPrintable

    Details

      Description

      This ticket follows on DM-15150 to create a command line interface for the nbreport client application.

      The CLI is designed in https://sqr-023.lsst.io/v/DM-15003

      Specifically, this ticket will create the nbreport test test CLI. This command demonstrates most of the notebook-related workflow without involving GitHub or the api.lsst.codes/nbreport service. It will

      • Create a test report instance from a report repository
      • Render the notebook from the template
      • Execute the notebook

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15195 Add git cloning capability to nbreport

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15003 Draft technote on design of notebook-based reports

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15150 Create APIs for rendering a templated Jupyter Notebook in nbreport

          • Done

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-14551 [ 91770 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-15003 [ DM-15003 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-15150 [ DM-15150 ]
            jsick Jonathan Sick made changes -
            Risk Score 0
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Change log:

            • New nbreport command-line interface, implemented with Click.
            • New nbreport test command that is designed for locally testing report repositories and ensuring that they render and compute correctly. This command creates a report instance, renders the templated variables, and computes the notebook.
            • New nbreport.repo module to handle report repositories and their configurations.
            • New nbreport.instance module to handle report instances.
            • New nbreport.compute module to run notebook instances to compute their cell outputs.
            Show
            jsick Jonathan Sick added a comment - Change log: New nbreport command-line interface, implemented with Click. New nbreport test command that is designed for locally testing report repositories and ensuring that they render and compute correctly. This command creates a report instance, renders the templated variables, and computes the notebook. New nbreport.repo module to handle report repositories and their configurations. New nbreport.instance module to handle report instances. New nbreport.compute module to run notebook instances to compute their cell outputs.
            jsick Jonathan Sick made changes -
            Risk Score 0 1
            jsick Jonathan Sick made changes -
            Story Points 4.7
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-15195 [ DM-15195 ]
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Released as nbreport 0.3.0

            Show
            jsick Jonathan Sick added a comment - Released as nbreport 0.3.0
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status In Progress [ 3 ] Done [ 10002 ]

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.