cabrita.command¶

Command module.

This module has the CabritaCommand class, which is responsible for:

Load and check for valid cabrita.yml file
Load and check for valid docker-compose.yml files
Generate and add docker services to boxes
Generate and add watchers to dashboard

class cabrita.command.CabritaCommand(cabrita_path: str, compose_path: tuple, background_color: Union[str, NoneType] = 'black', version: str = 'dev') → None¶

Bases: object

Cabrita Command class.

background_color¶

Return Background Color enum.

Returns:	BoxColor instance

execute() → None¶

Execute dashboard to show data in terminal.

Returns:	None

has_a_valid_compose¶

Return if Compose data is valid.

Returns:	bool

has_a_valid_config¶

Return if Config data is valid.

Returns:	bool

prepare_dashboard() → None¶

Prepare the dashboard.

Returns:	None

read_compose_files() → None¶

Read docker compose files data.

Returns:	None

cabrita.versions¶

Version package.

Checks version number for upgrades in PyPI

cabrita.versions.check_version() → str¶

Check if it is the latest version.

Compares actual version vs last known version in PyPI, for upgrades

Returns:	string

cabrita.versions.versions() → Union[List[str], NoneType]¶

Return the version list data from PyPI.

Returns:	list