secureworks / taegis-magic

Taegis Magic is a Jupyter Notebook and Command Line Interface for interacting with the Secureworks Taegis™ security platform. The Magics project is intended to assist users with workflows and analysis through Jupyter Notebook integrations and Pandas DataFrames.
https://www.secureworks.com/
Apache License 2.0
8 stars 5 forks source link

Fallback to ipynbname when papermill or vscode fn is available #5

Closed rcobb-scwx closed 2 months ago

mpegman-scwx commented 1 year ago

@rcobb-scwx

First this needs a DCO commit:

git commit --amend --no-edit --signoff
git push -f origin <branch_name>

https://www.secondstate.io/articles/dco/

Second:

The if cascade could better be implemented by a coalesce-like (or first valid) function that take a dict, list of keys, and a default value. Support for other automation tools, like Papermill, will be easier to manage and safer than a cascading if/elif block. Another goal is the the hope will be that first-party support for getting a notebook name will become available and we would be able to easily switch as this isn't something we want to maintain.

Third:

The report naming is currently outside the scope of the magic. The only integrations that should be included are those that are required for magic functionality, in this case for caching the results to the notebook. This should be implemented on the side that will be producing the report as there is no tooling around it in the magic.

mpegman-scwx commented 2 months ago

These updates have been implemented as part of a larger update to support notebook execution and report generation.

https://github.com/secureworks/taegis-magic/pull/24