songbirdcli 🐦

Music downloading client featuring mp3 or m4a tagging.

Dependencies

1. deno
2. ffmpeg

Install via Pip

Run

pip install songbirdcli

To run (with minimal features enabled) use:

RUN_LOCAL=true GDRIVE_ENABLED=false ITUNES_ENABLED=false python3 songbirdcli

See Configuration for how to configure the CLI via Environment variables. Without configuration, songbirdcli saves it's data relative to the script's directory.

Install via Docker

To run the app via docker, you will require:

1. docker: https://docs.docker.com/get-docker/

Note: to be gung-ho, add --pull always to any of the below commands to always receive the latest and greatest images.

First, initialize your docker volumes

make volumesinit

Note: bash or zsh aliases are provided below, assuming you clone songbird into your home directory into ~/proj/cboin1996/.

Itunes and Google Drive Integration

Macos:

alias songbirdgi="docker run -it --env-file "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/docker.env \
	-v "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/data/dump:/app/data/dump \
	-v "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/data/gdrive:/app/data/gdrive \
    -v "${HOME}"/Music/iTunes/iTunes\ Media/Automatically\ Add\ to\ Music.localized:/app/data/itunesauto \
    -v "${HOME}"/Music/Itunes/Itunes\ Media/Music:/app/data/ituneslib \
	-p 8080:8080 \
	--hostname songbird \
	--pull always \
	cboin/songbird:latest"

Windows:

Install windows sub-system for linux and setup the below alias:

alias songbirdgi="docker run -it --env-file "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/docker.env \
	-v "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/data/dump:/app/data/dump \
	-v "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/data/gdrive:/app/data/gdrive \
    -v /mnt/c/Users/*/Music/iTunes/iTunes\ Media/Automatically\ Add\ to\ Music:/app/data/itunesauto \
    -v /mnt/c/Users/*/Music/iTunes/iTunes\ Media/Music:/app/data/ituneslib \
	-p 8080:8080 \
	--hostname songbird \
	--pull always \
	cboin/songbird:latest"

Minimal configuration

By default, the app assumes itunes is installed. At minimum, create a .env file with to run without either.

In addition, you need a folder to store local files in. This folder will be passed as a volume mount to the dockerized app, as above in -v "app/data/dump":"app/data/dump", and is initialized automatically when running make volumesinit`.

ITUNES_ENABLED=False
GDRIVE_ENABLED=False

Gdrive Only

Create a .env file at the root of the project containing:

ITUNES_ENABLED=false
GDRIVE_FOLDER_ID=foo

Replace the foo with the folder id of your google drive folder. This is found in the url inside the folder when open in googledrive.

E.x: https://drive.google.com/drive/folders/foo

Follow https://developers.google.com/drive/api/quickstart/python, and place the credentials.json file at the app/data/gdrive folder at the root of the project.

alias songbirdg="docker run -it --env-file "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/docker.env \
	-v "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/data/dump:/app/data/dump \
	-v "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/data/gdrive:/app/data/gdrive \
	-p 8080:8080 \
	--hostname songbird \
	--pull always \
	cboin/songbird:latest"

Itunes Only

GDRIVE_ENABLED=false

Run

Macos:

alias songbirdi="docker run -it --env-file "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/docker.env \
        -v "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/data/dump:/app/data/dump \
        -v "${HOME}"/Music/iTunes/iTunes\ Media/Automatically\ Add\ to\ Music.localized:/app/data/itunesauto \
        -v "${HOME}"/Music/Itunes/Itunes\ Media/Music:/app/data/ituneslib \
	--pull always \
        cboin/songbird:latest"

Windows:

Install windows sub-system for linux and setup the below alias:

alias songbirdi="docker run -it --env-file "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/docker.env \
	-v "${HOME}"/proj/cboin1996/songbird/songbirdcli/songbirdcli/data/dump:/app/data/dump \
    -v /mnt/c/Users/*/Music/iTunes/iTunes\ Media/Automatically\ Add\ to\ Music:/app/data/itunesauto \
    -v /mnt/c/Users/*/Music/iTunes/iTunes\ Media/Music:/app/data/ituneslib \
	-p 8080:8080 \
	--hostname songbird \
	--pull always \
	cboin/songbird:latest"

Install as Package

To use songbirdcli as a python package, use

pip install songbirdcli

See tests for an example of configuring and running songbirdcli as a package.

For API documentation, view here

Development

To run the application locally, you can use a vscode debugger. You should also setup a .env file with the parameter RUN_LOCAL=True.

Requirements

1. Clone songbirdcore adjacent to this project.

2. Next, run

   export ENV=dev
   make setup
   

3. Follow the outputted instructions from make setup.

4. Next, run:

   make requirements
   

Note: the above command performs an editable install of songbirdcore

This allows you to edit songbirdcore locally, and have those changes directly integrated with this application when developing. To install the official stable version use

pip install songbirdcore

Debug CLI

Vscode debugger can be configured to run the cli.py file with the following .vscode/launch.json file

{
	"configurations": [
		{
			"name": "Python: Current File",
			"type": "python",
			"request": "launch",
			"program": "./songbirdcli/cli.py",
			"console": "integratedTerminal",
			"justMyCode": true,
			"envFile": "./dev.env"
		},
	]
}

Alternatively, you can simply run the app directly with

python3 songbirdcli/cli.py

Linting

To lint the app, run

make lint

Configuration

The following table summarizes the configurable parameters for the app, these can be setup in a .env file at the root of the project, and passed to docker with --env-file .env.