📜 Poster

Module: poster.py

Generates posters based on track or album information.

class Poster(output: str)

A class for generating and saving posters containing track or album information.

Parameters:

output (str) – Path where posters will be saved.

track(metadata: TrackMetadata, lyrics: str, accent: bool = False, theme: Literal['Light', 'Dark', 'Catppuccin', 'Gruvbox', 'Nord', 'RosePine', 'Everforest'] = 'Light', pcover: str | None = None) → None

Generates a poster for a track, which includes lyrics.

Parameters:

• metadata (TrackMetadata) – Track’s Metadata.

• lyrics (str) – The lyrics of the track.

• accent (bool, optional) – Adds an accent at the bottom of the poster. Defaults to False.

• theme (ThemesSelector.Options, optional) – Specifies the theme to use. Must be one of “Light”, “Dark”, “Catppuccin”, “Gruvbox”, “Nord”, “RosePine”, or “Everforest”. Defaults to “Light”.

• pcover (Optional[str]) – Path to a custom cover image. Defaults to None.

album(metadata: AlbumMetadata, indexing: bool = False, accent: bool = False, theme: Literal['Light', 'Dark', 'Catppuccin', 'Gruvbox', 'Nord', 'RosePine', 'Everforest'] = 'Light', pcover: str | None = None) → None

Generates a poster for an album, which includes track listing.

Parameters:

• metadata (AlbumMetadata) – Metadata containing details about the album.

• indexing (bool, optional) – Add index numbers to the tracks. Defaults to False.

• accent (bool, optional) – Add an accent at the bottom of the poster. Defaults to False.

• theme (ThemesSelector.Options, optional) – Specifies the theme to use. Must be one of “Light”, “Dark”, “Catppuccin”, “Gruvbox”, “Nord”, “RosePine”, or “Everforest”. Defaults to “Light”.

• pcover (Optional[str]) – Path to a custom cover image. Defaults to None.