Free Music Ninja API

.. image:: https://circleci.com/gh/FreeMusicNinja/api.freemusic.ninja.png?style=badge :target: https://circleci.com/gh/FreeMusicNinja/api.freemusic.ninja

.. image:: https://codecov.io/github/FreeMusicNinja/api.freemusic.ninja/coverage.svg?branch=master :target: https://codecov.io/github/FreeMusicNinja/api.freemusic.ninja?branch=master

Requirements

This project requires Python 3 and PostgreSQL:

.. code-block:: bash

$ sudo apt-get install python3-dev libpq-dev postgresql postgresql-contrib

Installation

First, setup a Python 3 virtual environment. The simple way:

.. code-block:: bash

$ virtualenv -p $(which python3) ../../venv
$ . ../../venv/bin/activate

Install Python dependencies (in a virtualenv preferably):

.. code-block:: bash

$ pip install -r requirements.txt

Every time you use the manage.py server you'll need to make sure you're in the virtual environment:

.. code-block:: bash

$ . ../../venv/bin/activate

Environment Variables

This project uses environment variables for configuration.

1. ECHONEST_API_KEY: Credentials for The Echo Nest API_
2. JAMENDO_CLIENT_ID: Credentials for Jamendo API_
3. FMA_API_KEY: Credentials for FreeMusicArchive API_
4. SECRET_KEY: Secret key_ for cryptographic signing
5. DATABASE_URL: URL for database connection (see database URL schema_)

If you don't want to setup Postgres, set DATABASE_URL to sqlite:///freemusicninja.db

Database Migrations

To initialize or update the database:

.. code-block:: bash

./manage.py migrate

To create a new super user:

.. code-block:: bash

./manage.py createsuperuser

Fixtures

There are database fixtures for artist data provided in a submodule.

To update the fixtures submodule:

.. code-block:: bash

$ git submodule update --init

To install the fixture data:

.. code-block:: bash

$ ./manage.py loaddata artist fmaartist jamendoartist magnatuneartist

Running the Server

To start the Django server:

.. code-block:: bash

$ ./manage.py runserver 3200

Now visit http://localhost:3200/ in your browser.

Deployment

There is a deploy task in the Fabric file. Unfortunately Fabric currently requires Python 2 so you'll need to install and use it in a Python 2 environment.

.. code-block:: bash

$ fab deploy

.. _database url schema: https://github.com/kennethreitz/dj-database-url#url-schema .. _freemusicarchive api: http://freemusicarchive.org/api/ .. _jamendo api: https://developer.jamendo.com/ .. _postgresql: https://www.python.org/downloads/ .. _python 3: https://www.python.org/downloads/ .. _secret key: https://docs.djangoproject.com/en/1.7/ref/settings/#std:setting-SECRET_KEY .. _the echo nest api: https://developer.echonest.com/