msticpy package

Jupyter and Python Tools for InfoSec.

Requires Python 3.8 or later.

To quickly import common modules into a notebook run:

>>> import msticpy as mp
>>> mp.init_notebook()

If not running in a notebook/IPython use >>> mp.init_notebook(globals())

To see help on init_notebook: >>> help(mp.init_notebook)

Search msticpy modules for a keyword: >>> mp.search(keyword)

Full documentation is available at: https://msticpy.readthedocs.io

GitHub repo: https://github.com/microsoft/msticpy

Package structure:

  • analysis - analysis functions

  • auth - authentication and secrets management

  • common - utility functions, common types, exceptions

  • config - configuration tool

  • data - queries, data access, context functions

  • datamodel - entities and pivot functions

  • init - package initialization

  • nbtools - deprecated location

  • nbwidgets - notebook widgets

  • resources - data resource files

  • transform - data transforms and decoding

  • vis - visualizations

Configuration:

  • set MSTICPYCONFIG environment variable to point to the path of your msticpyconfig.yaml file.

Subpackages