Metadata-Version: 2.1
Name: pycmus
Version: 0.1.1
Summary: A python cmus remote library
Author: Matthew Treinish
Author-email: mtreinish@kortar.org
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: pbr (>=1.6)
Requires-Dist: six (>=1.9.0)

======
pycmus
======
A python library for sending commands to the cmus music player:

https://cmus.github.io/

It uses the same socket interface as the cmus-remote command.

Complete documentation is here: http://pycmus.readthedocs.io/en/latest/

Usage
=====

Using pycmus is pretty straightforward you just need to init a PyCmus object
and then issue commands to it. For example::

  from pycmus import remote

  cmus = remote.PyCmus()
  print(cmus.status())

will connect to a running cmus instance (with the socket file in the default
location) and print the player status.

For a complete API documentation see: :ref:`pycmus_api`.