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

Create uservice_nbreport project for publishing notebook-based reports

    XMLWordPrintable

    Details

      Description

      This ticket is intended to create a new microservice within the api.lsst.codes umbrella called uservice_nbreport. This service is envisioned in https://sqr-023.lsst.io (DM-15003). This ticket will involve creating the codebase and configuring a minimally-viable deployment. Many domain specific features like customized HTML generation may be index pages will be deferred to future tickets.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15216 Add a "nbreport login" command

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15243 LSST the Docs Keeper features for Notebook-based report system (nbreport)

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15253 Add nbreport issue and other core commands that interact with api.lsst.codes/nbreport

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15306 Implement LSST-themed ipynb to HTML conversion for notebook-based report system

          • 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

            Activity

            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            First development release of ``uservice_nbreport`` (version 0.1.0).

            • Implemented GitHub personal access token-based authentication and GitHub organization-based authentication.
            • Implemented a ``POST /nbreport/reports/`` endpoint to register new reports.
              On the backend, this command creates a new product on LSST the Docs.
            • Implemented a ``POST /reports/<report>/instances/`` endpoint to reserve a new instance identifier.
              On the backend, this command creates a new edition on LSST the Docs.
              It uses LTD Keeper's new ``autoincrement`` feature.
            • Stubbed out a ``POST /reports/<report>/instances/<instance_id>/notebook`` endpoint to upload notebooks (ipynb) to.
              Currently this endpoint doesn't do anything with the notebook.
            Show
            jsick Jonathan Sick added a comment - First development release of ``uservice_nbreport`` (version 0.1.0). Initialized repository from https://github.com/lsst-sqre/uservice-bootstrap and further customized the Flask application around an application factory and blueprints. Implemented GitHub personal access token-based authentication and GitHub organization-based authentication. Implemented a ``POST /nbreport/reports/`` endpoint to register new reports. On the backend, this command creates a new product on LSST the Docs. Implemented a ``POST /reports/<report>/instances/`` endpoint to reserve a new instance identifier. On the backend, this command creates a new edition on LSST the Docs. It uses LTD Keeper's new ``autoincrement`` feature. Stubbed out a ``POST /reports/<report>/instances/<instance_id>/notebook`` endpoint to upload notebooks (ipynb) to. Currently this endpoint doesn't do anything with the notebook.

              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.