Skip to content

repo_on_fire.constants

Constant definitions.

APP_AUTHOR = 'RPdev' module-attribute

The app's author (as used e.g. in file paths).

APP_NAME = 'RepoOnFire' module-attribute

The name of the app (as used e.g. in file paths).

CACHE_ENTRY_STAMP_FILE = '.repo-on-fire-stamp' module-attribute

The name of the stamp file stored in cached workspaces.

CONFIG_FILE_NAME = 'config.toml' module-attribute

The file name of the settings file.

CONFIG_FILE_NAME_ENV_VAR = 'REPO_ON_FIRE_CONFIG_FILE_PATH' module-attribute

The name of the environment variable pointing to the config file.

Using this environment variable, the path to the configuration file to read can be overridden.

WorkspaceCacheStrategy

Bases: str, Enum

The strategy to use for workspace cache handling.

Source code in repo_on_fire/constants.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class WorkspaceCacheStrategy(str, Enum):
    """The strategy to use for workspace cache handling."""

    auto_sync = "auto_sync"
    """Automatically cache workspaces.

    With this strategy, when a new workspace is initialized, a mirror workspace
    in the cache will be created and the new workspace will use it as a
    reference. If the mirror workspace already exists, it will be kept up to
    date whenever new workspaces are created.
    """

    auto_sync_dissociate = "auto_sync_dissociate"
    """Automatically cache workspaces but remove association to cache.

    This strategy is similar to `auto_sync`, however, the newly created
    workspace will be dissociated from the cache entry after initial sync.
    """

auto_sync = 'auto_sync' class-attribute instance-attribute

Automatically cache workspaces.

With this strategy, when a new workspace is initialized, a mirror workspace in the cache will be created and the new workspace will use it as a reference. If the mirror workspace already exists, it will be kept up to date whenever new workspaces are created.

auto_sync_dissociate = 'auto_sync_dissociate' class-attribute instance-attribute

Automatically cache workspaces but remove association to cache.

This strategy is similar to auto_sync, however, the newly created workspace will be dissociated from the cache entry after initial sync.