Skip to main content

Adds audio plugin to django CMS.

Project description

pypi build coverage

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.

This addon is compatible with Aldryn and is also available on the django CMS Marketplace for easy installation.

preview.gif

Contributing

This is a an open-source project. 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.

One of the easiest contributions you can make is helping to translate this addon on Transifex.

Documentation

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

  • Python 2.7, 3.3 or higher

  • Django 1.8 or higher

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djangocms-audio-0.1.2.tar.gz (9.8 kB view details)

Uploaded Source

File details

Details for the file djangocms-audio-0.1.2.tar.gz.

File metadata

File hashes

Hashes for djangocms-audio-0.1.2.tar.gz
Algorithm Hash digest
SHA256 914024e90d3d80cedc1009013d9a3ec4ef7ae26d7bfec9b7357eafd2f45c8619
MD5 9512e70b2bb64a55500ec4cbf1f8e1ef
BLAKE2b-256 97df8646785d987adfd4bea9957fdb70c49e9c2ff9ef9af265724346f6607a1f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page