# cmus-remote

**Repository Path**: noctua/cmus-remote

## Basic Information

- **Project Name**: cmus-remote
- **Description**: Forked from: https://github.com/kiike/cmus-remote
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-24
- **Last Updated**: 2022-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

cmus-remote
===========

Description
-----------

cmus-remote small Flask app that acts as a remote control for C*mus. It
shows the current playing tracks, as well as allowing the user to play,
pause or skip tracks. As a Python app, it contains the `backend.py`
file, which can be imported in a different Python script.

The motivation to write this was to learn Python classes, interfacing to
sockets, and developing a small Flask application that could be deployed
to my Raspberry Pi (which is the machine running our favorite music
player).

This is a recent screenshot. Note that I'm not a UI designer as you can
see:

![a cmus-remote screenshot](screenshot.png)

Installation
------------

0. Requirements:
    - [Python 2.7](http://python.org)
    - [Flask](http://flask.pocoo.org)
    - [Werkzeug](http://werkzeug.pocoo.org)
    - [Jinja2](http://jinja.pocoo.org/)
    - [cmus](http://cmus.sf.net)

1. Clone this repo to the destination of your choosing.

2. Customise `cmus-remote.ini` according to your taste:
    - Cmus() takes a `user` parameter, which is the user that is running
    C*mus. Note that you need write access to talk to the socket.
    - If you call the app from within a python interpreter, it will
    listen on the port specified in the last line of the file.

3. Run the application:
    - from an WSGI service such as UWSGI.
    - from a python interpreter (it will listen on `localhost:8080` by default.

License
-------

This app is uncopyrighted. The font (`static/icons.woff`) is [Font Awesome](http://fontawesome.io/), modified by `fontello`. My code (CSS, HTML, Python) is not copyrighted. I did it for fun and to learn Python, so understand it comes with no warranty of any kind. Please do send me tweaks, patches, pull requests, etc.