django CMS Audio

django CMS Audio is a set of plugins for django CMS that allow you to publish audio files on your site (using an HTML5 player by default, but you can override this in your own templates if required).

It uses files managed by Django Filer. The plugins allow you to select a single file or an entire folder of files.

Note

This project is considered 3rd party (no supervision by the django CMS Association). Join us on Slack for more information.

Contribute to this project and win rewards

Because this is a an open-source project, we welcome everyone to get involved in the project and receive a reward for their contribution. Become part of a fantastic community and help us make django CMS the best CMS in the world.

We'll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

We're grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

Documentation

See REQUIREMENTS in the setup.py file for additional dependencies:

• Django Filer 1.7 or higher

Make sure django-filer is installed and configured appropriately.

Installation

For a manual install:

• run pip install djangocms-audio
• add djangocms_audio to your INSTALLED_APPS
• run python manage.py migrate djangocms_audio

Configuration

Note that the provided templates are very minimal by design. You are encouraged to adapt and override them to your project's requirements.

This addon provides a default template for all instances. You can provide additional template choices by adding a DJANGOCMS_AUDIO_TEMPLATES setting:

DJANGOCMS_AUDIO_TEMPLATES = [
    ('feature', _('Featured Version')),
]

You'll need to create the feature folder inside templates/djangocms_audio/ otherwise you will get a template does not exist error. You can do this by copying the default folder inside that directory and renaming it to feature.

MP3 and OGG files are allowed by default. We recommend using MP3 as it's supported across all major browsers. You can change the default setting by overriding:

DJANGOCMS_AUDIO_ALLOWED_EXTENSIONS = ['mp3', 'ogg', 'wav']

Running Tests

You can run tests by executing:

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test