Playlist¶

New in version 2.0.0.

This cog adds the possibility to have as many playlists per user as you want.

It is compatible with the Music cog: see Music cog integration.

Hint

To enable this cog, set the ENABLE_PLAYLISTS variable.

Packages¶

The asyncpg package is used to connect to the PostgreSQL database.

The yt-dlp package is used to get validate the URL given and get the song information from Youtube.

env variables¶

Name	Description
`DB_MUSIC_HOST`	The hostname to connect to, usually `localhost` to use a local database
`DB_MUSIC_USER`	A `psql` user with access to the database
`DB_MUSIC_PASSWORD`	The `psql` user’s password
`DB_MUSIC_DATABASE`	The name of the database
`DB_MUSIC_PORT`	Optionally, which port to use when connecting to the database

Creating the database¶

This cog uses PostgreSQL, a “powerful, open source object-relational database system”. Its documentation is quite detailed, don’t hesitate to check it out when in doubt.

A quick guide on setting up PostgreSQL can be found at https://pimylifeup.com/raspberry-pi-postgresql/.

For this cog, the steps to follow are:

Install PostgreSQL: check its downloads page. If you haven’t installed PostgreSQL before, I recommend using version 13 since it’s the one I used to develop this cog.
Switch to user postgres with:
```
sudo su postgres
```
Create a new role. You can use any username you want. Use the command:
```
createuser <username> -P -D -R -S
```
This creates a role named username. It requires creating a password (-P). The role cannot create databases (-D), roles (-R) and won’t be a superuser (-S).
Launch the CLI with the psql command (while still connected as user postgres).
Create the database. You can use any name (except songs, playlists or songs_in_playlists to avoid any confusion). You can name it music for example. Use the command:
```
CREATE DATABASE <name> OWNER <username>;
```
Where username is the name of the user created in step 3.
You can now exit the CLI with \q and return to your usual user with exit.
Set the .env variables starting with DB_MUSIC:
- HOST should be localhost.
- USER is the name of the user you created in step 3.
- PASSWORD is that user’s password.
- DATABASE is the name of the database (music in the example).
- PORT is the port used to connect to the database. By default, its 5432.
Once the variables are set, use config.py to create the tables needed by the cog:

Unix (Linux/MacOS)

python3 config.py --database

Windows

py config.py --database

Note

When restarting the computer, you may need to restart the database server. For Ubuntu, use sudo service postgresql start to do so. For distros with systemd, it should be sudo systemctl start postgresql.

Music cog integration¶

Like the Favourites cog, this cog has two commands that use the Music cog:

now adds the currently playing song to the default ‘favourites’ list or one specified by the user.
play queues a playlist or a specific song from a playlist.

It also uses the YTDLSource class that comes in the Music cog to generate the Song to save with add. This does not require enabling the Music cog in order to work.