Metadata-Version: 2.0
Name: DropTheBeat
Version: 0.0.6
Summary: Music sharing using Dropbox.
Home-page: http://github.com/jacebrowning/dropthebeat
Author: Jace Browning
Author-email: jacebrowning@gmail.com
License: LGPL
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Communications :: File Sharing
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Dist: PyYAML (==3.10)

DropTheBeat
===========

| |Build Status|
| |Coverage Status|
| |PyPI Version|

Music sharing using Dropbox.

Features
--------

-  Recommend songs to friends
-  Get a list of songs shared by friends
-  Download the songs to your computer

Getting Started
===============

Requirements
------------

-  Python 3: http://www.python.org/download/releases/3.3.3/#download

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

DropTheBeat can be installed with ``pip`` or ``easy_install``:

::

    pip install DropTheBeat

Or directly from the source code:

::

    python setup.py install

Initial Setup
-------------

#. Create a folder named 'DropTheBeat' in your Dropbox
#. Share this folder with your friends

Graphical Interface
===================

Start the app:

::

    DropTheBeat

Command-line Inteface
=====================

Create your user folder:

::

    dtb --new <FirstLast>

Recommend a song to friends:

::

    dtb --share <path/to/a/song>
    dtb --share <path/to/a/song> --users JohnDoe JaneDoe

Display recommended songs:

::

    dtb --incoming
    dtb --outoing

Download recommended songs:

::

    dtb
    dtb --daemon

Launch the GUI:

::

    dtb --gui

For Developers
==============

Requirements
------------

-  Python 3: http://www.python.org/download/releases/3.3.3/#download
-  GNU Make:

   -  Windows: http://cygwin.com/install.html
   -  Mac: https://developer.apple.com/xcode
   -  Linux: http://www.gnu.org/software/make

-  virtualenv: https://pypi.python.org/pypi/virtualenv
-  Pandoc: http://johnmacfarlane.net/pandoc/

Environment
-----------

Create a virtualenv:

::

    make develop

Run static analysis:

::

    make doc
    make pep8
    make pylint
    make check  # all of the above

Run the tests:

::

    make test
    make tests  # includes integration tests

Launch the GUI from the virtualenv:

::

    make gui  # sets TCL_LIBRARY on Windows

.. |Build Status| image:: https://travis-ci.org/jacebrowning/dropthebeat.png?branch=master
   :target: https://travis-ci.org/jacebrowning/dropthebeat
.. |Coverage Status| image:: https://coveralls.io/repos/jacebrowning/dropthebeat/badge.png?branch=master
   :target: https://coveralls.io/r/jacebrowning/dropthebeat?branch=master
.. |PyPI Version| image:: https://badge.fury.io/py/DropTheBeat.png
   :target: http://badge.fury.io/py/DropTheBeat


