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.

preview.gif

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:

python django djangocms

  • 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

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-2.1.1.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

djangocms_audio-2.1.1-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: djangocms-audio-2.1.1.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for djangocms-audio-2.1.1.tar.gz
Algorithm Hash digest
SHA256 9ae3e50a688713fc73a755bae9149af22a3a9ab30e8a1366657aafe73262f1b9
MD5 27d3538e7c6988c48f6462d6d3f03785
BLAKE2b-256 4baa888e6fb0a00212c04f403581ec5a85abeebf5c69b9e6423086578bdf097a

See more details on using hashes here.

Provenance

File details

Details for the file djangocms_audio-2.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for djangocms_audio-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e55cbdd05008b4bbf81608ca554d846bb7a8fb9ca94a821e58f374a245e6a2af
MD5 9557717bf0c582d85a399e2ac62eaf95
BLAKE2b-256 99837d36601d0676cbe83cad947ec32d85b57a083db4cf4cce393afcff18d440

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