Skip to content

settings

songbirdcli.settings

SongbirdCliConfig

Bases: BaseSettings

Configuration using .env file or defaults declared in here

get_itunes_folder_path()

If you run the app locally, configure the itunes path as an absolute path. Otherwise, the program will use the local container storage and assume to be running in a docker container.

Returns:

  • str ( str ) –

    the path to where itunes destined songs should live

Source code in songbirdcli/settings.py 
67
68
69
70
71
72
73
74
75
76
def get_itunes_folder_path(self) -> str:
    """If you run the app locally, configure the itunes path as an absolute path. Otherwise, the program will
    use the local container storage and assume to be running in a docker container.

    Returns:
        str: the path to where itunes destined songs should live
    """
    if self.run_local:
        return self.itunes_folder_path
    return os.path.join(self.get_data_path(), self.itunes_folder_path)

get_itunes_lib_path()

If you run the app locally, configure the itunes path as an absolute path. Otherwise, the program will use the local container storage and assume to be running in a docker container.

Returns:

  • str ( str ) –

    the path to where itunes destined songs should live

Source code in songbirdcli/settings.py 
78
79
80
81
82
83
84
85
86
87
def get_itunes_lib_path(self) -> str:
    """If you run the app locally, configure the itunes path as an absolute path. Otherwise, the program will
    use the local container storage and assume to be running in a docker container.

    Returns:
        str: the path to where itunes destined songs should live
    """
    if self.run_local:
        return self.itunes_lib_path
    return os.path.join(self.get_data_path(), self.itunes_lib_path)

SongbirdServerConfig

Bases: BaseSettings

Configuration using .env file or defaults declared in here