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 Divio Cloud 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.

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

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

Uploaded Source

Built Distribution

djangocms_audio-2.0.0-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: djangocms-audio-2.0.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for djangocms-audio-2.0.0.tar.gz
Algorithm Hash digest
SHA256 e96cda5a6422fb8a71bb6e8fa59f2390c105b88529ac879fb06ecd74d85d3302
MD5 a8dc46485a880d46bb443fbe582b2a59
BLAKE2b-256 92899e6e8e429c304260ab0bf006c06e0b7a275d27848b6a85c8e6b6c1bbdf79

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: djangocms_audio-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 26.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for djangocms_audio-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 733aa53ecffea7fc4596cc6c5925479f7826b0356a5ee085f2b1ab636da777d5
MD5 12c08572ee7afdd52e5c8a266e30b886
BLAKE2b-256 85cde9c571881c05968cab97fd56e1c2d62b6eb6a74a68395435d4c8791755e8

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