saturnin._scripts.commands.site

Saturnin site manager commands

Globals

saturnin._scripts.commands.site.app

Typer command group for site management commands

Parameters:

  • args (Any) –

  • kwargs (Any) –

Return type:

Any

Enums

class saturnin._scripts.commands.site._Configs(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

Saturnin configuration files

FIREBIRD = 'firebird'
LOGGING = 'logging'
MAIN = 'main'
THEME = 'theme'
USER = 'user'
property path: Path

Path to configuration file.

Command functions

saturnin._scripts.commands.site.create_home() → None[source]

Creates Saturnin home directory in Saturnin virtual environment.

—

#### Important:

To have desired effect, this command must be executed BEFORE initialize.

Return type:

None

saturnin._scripts.commands.site.initialize(new_config: bool = <typer.models.OptionInfo object>, yes: bool = <typer.models.OptionInfo object>) → None[source]

Initialize Saturnin environment/installation.

—

It creates required directories and configuration files.

#### Important:

Before you execute this command, consider where you want to place numerous Saturnin directories. By default, Saturnin uses directory scheme according to platform standards.

  • If you want to place main directories under central home directory, set SATURNIN_HOME environment variable to point to this directory.

  • If you want to place home directory in Saturnin virtual environment, first execute the create home command.

Parameters:
Return type:

None

saturnin._scripts.commands.site.list_directories() → None[source]

List Saturnin directories. Emojis: :heavy_check_mark: :heavy_multiplication_x:

Return type:

None

saturnin._scripts.commands.site.list_configs() → None[source]

List Saturnin configuration files.

Return type:

None

saturnin._scripts.commands.site.list_datafiles() → None[source]

List Saturnin data files.

Return type:

None

saturnin._scripts.commands.site.show_config(config_file: ~saturnin._scripts.commands.site._Configs = <typer.models.ArgumentInfo object>)[source]

Show content of configuration file.

Parameters:

config_file (_Configs) –

saturnin._scripts.commands.site.edit_config(config_file: ~saturnin._scripts.commands.site._Configs = <typer.models.ArgumentInfo object>)[source]

Edit configuration file.

Parameters:

config_file (_Configs) –

saturnin._scripts.commands.site.create_config(config_file: ~saturnin._scripts.commands.site._Configs = <typer.models.ArgumentInfo object>, new_config: bool = <typer.models.OptionInfo object>)[source]

Creates configuration file with default content.

Parameters:

Functions

saturnin._scripts.commands.site.ensure_dir(description: str, path: Path)[source]

Create directory (incl. parents) if it does not exists.

Parameters:

  • description (str) – Directory description.

  • path (Path) – Directory path.

saturnin._scripts.commands.site.ensure_config(path: Path, content: str, new_config: bool)[source]

Create configuration file if it does not exists.

Parameters:

  • path (Path) – Configuration file.

  • content (str) – Content to be written into configuration file.

  • new_config (bool) – When True, the configuration file is written even if it elready exists, but original file is kept as renamed with ‘.bak’ suffix.

saturnin._scripts.commands.site.add_path(table: Table, description: str, path: Path) → None[source]

Adds new row to table with information about path incl. indicator whether path exists.

Parameters:

  • table (Table) – Rich table

  • description (str) – Path description

  • path (Path) – Path

Return type:

None