Metadata-Version: 2.0
Name: DropTheBeat
Version: 0.0.1-rc.1
Summary: Music sharing using Dropbox.
Home-page: http://pypi.python.org/pypi/DropTheBeat
Author: Jace Browning
Author-email: jacebrowning@gmail.com
License: LGPL
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-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
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Communications :: File Sharing
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Dist: PyYAML (==3.10)
Requires-Dist: sqlalchemy (==0.8.3)

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

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

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
------------

-  GNU Make (or Cygwin Make): http://www.gnu.org/software/make/
-  Pandoc: http://johnmacfarlane.net/pandoc/
-  virtualenv: https://pypi.python.org/pypi/virtualenv

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

::

    make develop  # creates the virtualenv

    make doc  # runs documentation generation 
    make pep8  # runs pep8 analysis
    make pylint  # runs pylint
    make check  # runs all of the above

    make test  # runs the unit tests
    make tests  # runs the integration tests

    make gui  # launch the GUI from the virtualenv



