sync-dl 1.1.0

A tool for downloading and syncing remote playlists to your computer

sync-dl

A tool for downloading and syncing remote playlists to your computer

• INSTALLATION
• ABOUT
• USAGE
• EXAMPLE
• DEVLOPMENT

INSTALLATION

Requires ffmpeg or avconv, however one of these comes pre-installed on most machines.

Install sync-dl via pypi using pip:

pip install sync-dl

ABOUT

Created to avoid having music deleted but still have the convenience of browsing, adding and reordering new music using youtube.

The application does not store any of its metadata in songs, metadata is stored next to them in a .metadata file, the music files are managed through numbering, allowing them to be played alphanumerically using any playback service (such as VLC).

Usage

sync-dl [options] PLAYLIST

Where playlist is simply the name of the directory you wish to store the playlist in. playlist directory will always be in current working directory unless a music directory is specified using the -l, --local-dir option to hard set a music directory.

To see all options use the command:

sync-dl -h

Smart Sync:

The main feature of sync-dl

sync-dl -s PLAYLIST

Adds new music from remote playlist to local playlist, also takes ordering of remote playlist without deleting songs no longer available in remote playlist.

Songs that are no longer available in remote, will remain after the song they are currently after in the local playlist.

Push Order:

sync-dl has a submodule which uses the youtube api the preform the reverse of Smart Sync called Push Order. sync-dl will prompt you to install the submodule if you use any of its options ie) --push-order. you must also sign in with google (so sync-dl can edit the order of your playlist)

For more information see https://github.com/PrinceOfPuppers/sync-dl-ytapi

Many More!

Includes tools for managing the order of songs which work well for large playlists, ie) --move-range, which allows a user to move a block of songs to a different posistion. doing so on youtube would require moving each song individually using clunky drag and drop tools.

EXAMPLE

sync-dl -l my/local/music/folder

Will use my/local/music/folder to store and manipulate playlist in the future.

sync-dl -n https://www.youtube.com/playlist?list=PL-lQgJ3eJ1HtLvM6xtxOY_1clTLov0qM3 sweetJams

Will create a new playlist at my/local/music/folder/sweetJams and download the playlist at the provided url to it.

sync-dl -m 1 5 sweetJams

Will move song number 1 in the playlist to position 5.

sync-dl -a sweetJams

Will check for any new songs in the remote playlist and append them to the end of sweetJams.

sync-dl -s sweetJams

Will use smart sync on sweetJams, downloading new songs from the remote playlist and reordering the playlist to match the order of the remote playlist without deleting any songs that are no longer available.

sync-dl --move-range 0 4 8 sweetJams

Will move all songs from 0 to 4 to after song 8

sync-dl -p sweetJams

Will give you all the urls for the songs in sweetJams.

sync-dl --push-order sweetJams

Will prompt you to install sync-dl-ytapi and sign in with google (if you havent already), after doing so it will push the local order of the playlist to youtube.

DEVLOPMENT

To build for devlopment run:

git clone https://github.com/PrinceOfPuppers/sync-dl.git

cd sync-dl

pip install -e .

This will build and install sync-dl in place, allowing you to work on the code without having to reinstall after changes.

Automated Testing

python test.py [options] TEST_PLAYLIST_URL

Will run all unit and integration tests, for the integration tests it will use the playlist TEST_PLAYLIST_URL, options are -u and -i to only run the unit/integration tests respectively.

Testing requires sync-dl-ytapi to be installed aswell, and will test its helper functions.