google / picatrix Goto Github PK

ATM when you initialize a magic class it has an optional argument of arguments, which is a list of MagicArgument.

If it is not supplied it is ignored and arguments are derived from a docstring.

This could be detangled, and MagicArgument be better defined and used throughout. Also it should not be done in the __init__ function but arguments should be configured after initialization of the object.

Add magics that work with GRR

This will come after TS magics are in, at least.

Then aim to have a e2e test for each magic that we add to the project.

Add magics that help with working with osquery.

Right now all the arguments are constructed from parsing the docstring. This should be changed, to reduce the reliance on docstring parsing and instead make use of typing and the casting/verification that can be done there.

Add magics that work with the Timesketch API.

This will be stored in picatrix/__init__.py

Tasks:

• Import all magics
• Create a context object
• Create an init() function that creates the context object (or checks if it exists and returns it). This function will initialize the magic framework.

Instead of having just magics, we also need to have a way to register helper function so that they become discoverable.

Add a simple decorator to helper functions, framework.picatrix_helper that only takes the function and registers it.

None of the files that were checked in contain any unit tests. These need to be added.

This also requires:

• updating the setup.py file to include running the tests
• adding a GH action/workflow to run the tests.
• Adding test files for every file currently checked in

Expected Behavior

Actual Behavior

Steps to Reproduce the Problem

Specifications

• Version:
• Platform: