ni / ni/nisystemlink-clients-python

Auto-detect Notebook parameters for Publish

Open
#110 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10
Forks
32
Avg merge
12h 42m
Merged PRs (30d)
2

Description

The Notebook publish workflow from JupyterHub on SLE automatically detects the parameters based on the cell's papermill metadata.

https://github.com/ni/nisystemlink-clients-python/blob/4a965b48e791397d1aed56cd8dc2e7b0acade69d/examples/notebook/notebook.py#L13

Available API client expects the user to provide the parameters as metadata. A better user experience will be to select a notebook and the rest of the details auto-detected.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with examples/notebook/notebook.py at the linked parameter-handling lines, then trace the available publish API that currently requires metadata from the user. Define how notebook selection should detect papermill parameters and identify the API and workflow changes needed; done means publishing can use the selected notebook's detected parameters without manual metadata entry.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
api, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.