App Configuration

App-specific Flask settings.

Standard

gmusicprocurator.default_settings.GMP_FRONTEND_ENABLED

Defaults to True. If disabled, the code and views related to the frontend are not loaded. For example, GET / HTTP/1.1 will return a 404.

gmusicprocurator.default_settings.GMP_NODE_MODULES_DIR

Defaults to the node_modules directory in the top-level directory of the repository. This is the path where all of the Node-based asset utilities are installed.

gmusicprocurator.default_settings.GMP_SONG_FILTERS

A tuple of callable filters used on streaming MP3 data. By default, it looks like:

GMP_SONG_FILTERS = (
    'add_id3_tags_to_mp3',
)

Tuple items can be either strings (built-in to the app) or callables. Callables have the following signature:

def (str song_id, io.BytesIO data) -> io.BytesIO

gmusicprocurator.default_settings.GMP_EMBED_ALBUM_ART

Embed album art in the songs’ ID3 tags (assuming that ID3 tags are being embedded in the MP3s). Defaults to False.

Development

Settings that should only be configured if you are developing GMusicProcurator and/or you know what you’re doing.

gmusicprocurator.default_settings.GMP_OFFLINE_MODE

If set to True, the proxy views will only return the HTTP status code 503 (Service Unavailable). It is on by default only when Read the Docs is building the documentation.

gmusicprocurator.default_settings.GMP_MEMORY_PROFILER

Uses heapy to examine what objects are using the most memory in the app. Requires installing guppy (via pip install guppy). When the server is running, send the SIGUSR1 signal to the main process, and it will print out a frequency table of allocated objects, and shut down the server.

Google

gmusicprocurator.default_settings.GACCOUNT_EMAIL

The Google Account email address that has access to Google Music.

gmusicprocurator.default_settings.GACCOUNT_DEVICE_ID

The mobile device ID to use to access Google Music. See the installation docs for details.