ni / ni/nisystemlink-clients-python
Utilities to use scrapbook.glue in Notebook for execution results
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 32
- Avg merge
- 12h 42m
- Merged PRs (30d)
- 2
Description
SystemLink uses scrapbook to store result information from each notebook execution and display it to the user in the Execution Details slide-out.
There aren't many examples to demonstrate all possible supported result types and ways to format it.
# display hyperlink to a file
import scrapbook as sb
sb.glue(
name=f"Uploaded file to product {product_part_number}",
data=f'<a href="../../../../../files/file/{file_id}">File Link</a>',
)
Utilities to work with scrapbook in the context of Notebook results will simplify the developer experience.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue does not identify files, tests, or entry points. Start by reviewing how scrapbook.glue results are currently created and displayed for notebook executions, then define which result types and formats the utilities should support. Done means an agreed utility API with examples covering the supported notebook result formats.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100