pimlico.cli.shell.commands module

Basic set of shell commands that are always available.

class MetadataCmd

Bases: pimlico.cli.shell.base.ShellCommand

commands = ['metadata']

help_text = "Display the loaded dataset's metadata"

execute(shell, *args, **kwargs)

Execute the command. Get the dataset reader as shell.data.

Parameters:

• shell – DataShell instance. Reader available as shell.data
• args – Args given by the user
• kwargs – Named args given by the user as key=val

class PythonCmd

Bases: pimlico.cli.shell.base.ShellCommand

commands = ['python', 'py']

help_text = "Run a Python interpreter using the current environment, including import availability of all the project code, as well as the dataset in the 'data' variable"

execute(shell, *args, **kwargs)

Execute the command. Get the dataset reader as shell.data.

Parameters:

• shell – DataShell instance. Reader available as shell.data
• args – Args given by the user
• kwargs – Named args given by the user as key=val