poiesis.cli.commands.poiesis package¶

Submodules¶

poiesis.cli.commands.poiesis.api module¶

API service CLI commands.

class poiesis.cli.commands.poiesis.api.ApiCommand[source]¶

Bases: BaseCommand

API CLI command implementation.

add_run_command(group)[source]¶

Add API run command.

Parameters:: group (Group) – Click group to add the command to
Return type:: None

description: str = 'Commands to run the API server and display API information.'¶

get_info()[source]¶

Get API service information.

Return type:: dict[str, Any]
Returns:: Dictionary with API service information

help: str = 'API server management'¶

name: str = 'api'¶

poiesis.cli.commands.poiesis.base module¶

Base classes and utilities for CLI commands.

class poiesis.cli.commands.poiesis.base.BaseCommand[source]¶

Bases: object

Base class for all CLI commands.

add_info_command(group)[source]¶

Add the info command to the group.

Parameters:: group (Group) – Click group to add the command to
Return type:: None

abstractmethod add_run_command(group)[source]¶

Add the run command to the group.

This method should be overridden by subclasses.

Parameters:: group (Group) – Click group to add the command to
Return type:: None

add_version_command(group)[source]¶

Add the version command to the group.

Parameters:: group (Group) – Click group to add the command to
Return type:: None

create_command()[source]¶

Create a Click command group for this service.

Return type:: Group
Returns:: Click command group

description: str = 'Base command description'¶

get_info()[source]¶

Get information about the service.

Return type:: dict[str, Any]
Returns:: Dictionary with service information

help: str = 'Base command'¶

name: str = 'base'¶

classmethod register(group)[source]¶

Parameters:: group (Group) – The Click group to register with
Return type:: TypeVar(T, bound= BaseCommand)
Returns:: Instance of the command class

poiesis.cli.commands.poiesis.texam module¶

TExAM service CLI commands.

class poiesis.cli.commands.poiesis.texam.TexamCommand[source]¶

Bases: BaseCommand

TExAM CLI command implementation.

add_run_command(group)[source]¶

Add TExAM run command.

Parameters:: group (Group) – Click group to add the command to

description: str = 'Task Executor and Monitor service for managing task execution.'¶

get_info()[source]¶

Get TExAM service information.

Return type:: dict[str, Any]
Returns:: Dictionary with TExAM service information

help: str = 'Task Executor and Monitor service'¶

name: str = 'texam'¶

poiesis.cli.commands.poiesis.tif module¶

TIF service CLI commands.

class poiesis.cli.commands.poiesis.tif.TifCommand[source]¶

Bases: BaseCommand

TIF CLI command implementation.

add_run_command(group)[source]¶

Add TIF run command.

Parameters:: group (Group) – Click group to add the command to
Return type:: None

description: str = 'Task Input Filer service for handling task input files.'¶

get_info()[source]¶

Get TIF service information.

Return type:: dict[str, Any]
Returns:: Dictionary with TIF service information

help: str = 'Task Input Filer service'¶

name: str = 'tif'¶

poiesis.cli.commands.poiesis.tof module¶

TOF service CLI commands.

class poiesis.cli.commands.poiesis.tof.TofCommand[source]¶

Bases: BaseCommand

TOF CLI command implementation.

add_run_command(group)[source]¶

Add TOF run command.

Parameters:: group (Group) – Click group to add the command to
Return type:: None

description: str = 'Task Output Filer service for handling task output files.'¶

get_info()[source]¶

Get TOF service information.

Return type:: dict[str, Any]
Returns:: Dictionary with TOF service information

help: str = 'Task Output Filer service'¶

name: str = 'tof'¶

poiesis.cli.commands.poiesis.torc module¶

Torc service CLI commands.

class poiesis.cli.commands.poiesis.torc.TorcCommand[source]¶

Bases: BaseCommand

Torc CLI command implementation.

add_run_command(group)[source]¶

Add Torc run command.

Parameters:: group (Group) – Click group to add the command to
Return type:: None

description: str = 'Task Orchestrator service for orchestrating TES tasks.'¶

get_info()[source]¶

Get Torc service information.

Return type:: dict[str, Any]
Returns:: Dictionary with TOF service information

help: str = 'Task Orchestrator service'¶

name: str = 'torc'¶

Module contents¶

Commands for Poiesis services.

Commands are user to interact with services of Poiesis, eg TES, TIF, TOF, etc.