Skip to content

Kaleb0x/cmus-syncthing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cmus-syncthing

Exports cmus playlists to a specific directory (or sync directory) that can be synced with another device using Syncthing. It can be used to export cmus playlists and their corresponding tracks to an Android smartphone running Syncthing.

Requirements

See requirements.txt.

Installation

Manual installation

python setup.py build
sudo python setup.py install

System-specific installation

Packages are available on the following repositories:

Packaging status

Configuration

Minimal configuration

Before running cmus-syncthing for the first time, you need to generate a configuration file. To do so, run :

cmus-syncthing init

This command will generate a minimal configuration file located in $XDG_CONFIG_HOME containing the playlist and sync folders and a verbosity option.

Playlist exclusion

You can also exclude specific playlists from syncing. To do so, add their exact names in the configuration file as follows :

[Options]
exclude=playlist1,playlist2

A configuration file template is available for further details.

systemd unit files

systemd service and timer unit files can be used to run cmus-syncthing.

Running

Manual running

You can run cmus-syncthing manually from the command line when required :

$ cmus-syncthing

systemd service

Each system user can start/enable the provided systemd timer on a user level to sync their playlists. The timer runs cmus-syncthing every 15 minutes. Once the files are properly installed on your system, you can enable it by running :

$ systemctl --user enable cmus-syncthing.timer

Contribution

Contributions are welcome. Please read the contribution guidelines beforehand.

Licensing

This work is under the 0-clause BSD license. I would be very grateful to anyone who mentions me in any derivative work and distributes it back to the community. I'd rather see people act wisely as a trait, not by legal requirement.

About

Sync utility for cmus playlists using Syncthing

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages