ersilia.cli package

Subpackages

• ersilia.cli.commands package
  • Subpackages
    • ersilia.cli.commands.utils package
      • Module contents
  • Submodules
  • ersilia.cli.commands.catalog module
    • catalog_cmd()
  • ersilia.cli.commands.close module
    • close_cmd()
  • ersilia.cli.commands.delete module
    • delete_cmd()
  • ersilia.cli.commands.dump module
    • dump_cmd()
  • ersilia.cli.commands.example module
    • example_cmd()
  • ersilia.cli.commands.fetch module
    • fetch_cmd()
  • ersilia.cli.commands.info module
    • info_cmd()
  • ersilia.cli.commands.publish module
  • ersilia.cli.commands.run module
    • run_cmd()
  • ersilia.cli.commands.serve module
    • serve_cmd()
  • ersilia.cli.commands.test module
    • test_cmd()
  • ersilia.cli.commands.uninstall module
    • uninstall_cmd()
  • Module contents
    • ErsiliaCommandGroup
      • ErsiliaCommandGroup.NUMBER_OF_COMMON_PARAMS
      • ErsiliaCommandGroup.bentoml_common_params()
      • ErsiliaCommandGroup.command()

Submodules

ersilia.cli.cmd module

class ersilia.cli.cmd.Command

Bases: object

Command class to dynamically import and execute CLI commands.

catalog()

Display the catalog.

close()

Close the application.

delete()

Delete the application.

dump()

Dump precalculation.

example()

Show an example.

fetch()

Fetch data.

info()

Display information.

publish()

Publish data.

restart()

Restart the command.

run()

Execute the command.

serve()

Serve the application.

setup()

Set up the application.

stop()

Stop the command.

test()

Test the application.

uninstall()

Uninstall the application.

ersilia.cli.create_cli module

ersilia.cli.create_cli.create_ersilia_cli()

Creates and configures the Ersilia CLI.

This function initializes the Command class, checks if the user is a contributor, and dynamically imports and executes various CLI commands based on the user’s role.

Returns:

ersilia_cli – The configured Ersilia CLI module.

Return type:

module

ersilia.cli.echo module

class ersilia.cli.echo.Silencer

Bases: object

A class to manage the silencing of CLI output.

silence_file

Path to the silence file.

Type:

str

is_silence()

Checks if the CLI output is silenced.

speak()

Enables CLI output.

silence()

Disables CLI output.

is_silence()

Checks if the CLI output is silenced.

Returns:

True if the CLI output is silenced, False otherwise.

Return type:

bool

silence()

Disables CLI output.

speak()

Enables CLI output.

ersilia.cli.echo.echo(text, **styles)

Prints styled text to the CLI, optionally with emojis, unless silenced.

Parameters:

• text (str) – The text to be printed.

• **styles (dict) – Additional styling options for the text.

Return type:

None

ersilia.cli.messages module

class ersilia.cli.messages.ModelNotFound(model)

Bases: object

A class to handle the scenario when a model is not found.

model

The model object that was not found.

Type:

object

echo()

Prints an error message and exits the program.

echo()

Prints an error message indicating the model was not found and exits the program.

class ersilia.cli.messages.ModelNotInLocal(model_id)

Bases: object

A class to handle the scenario when a model is not found locally.

model_id

The identifier of the model that was not found locally.

Type:

str

echo()

Prints an error message and exits the program.

echo()

Prints an error message indicating the model was not found locally and exits the program.

Module contents

ersilia.cli.echo(text, **styles)

Prints styled text to the CLI, optionally with emojis, unless silenced.

Parameters:

• text (str) – The text to be printed.

• **styles (dict) – Additional styling options for the text.

Return type:

None