================
django CMS Audio
================
|pypi| |build| |coverage|
**django CMS Audio** is a set of plugins for `django CMS <http://django-cms.org>`_
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 <https://github.com/divio/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 <https://www.django-cms.org/en/about-us/>`_). Join us on `Slack <https://www.django-cms.org/slack/>`_ for more information.
.. image:: 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 <https://www.django-cms.org/en/contribute/>`_ and
`receive a reward <https://www.django-cms.org/en/bounty-program/>`_ 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
<http://docs.django-cms.org/en/latest/contributing/index.html>`_.
We're grateful to all contributors who have helped create and maintain this package.
Contributors are listed at the `contributors <https://github.com/django-cms/djangocms-audio/graphs/contributors>`_
section.
Documentation
=============
See ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-audio/blob/master/setup.py>`_
file for additional dependencies:
|python| |django| |djangocms|
* Django Filer 1.7 or higher
Make sure `django-filer <http://django-filer.readthedocs.io/en/latest/installation.html>`_
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
.. |pypi| image:: https://badge.fury.io/py/djangocms-audio.svg
:target: http://badge.fury.io/py/djangocms-audio
.. |build| image:: https://travis-ci.org/divio/djangocms-audio.svg?branch=master
:target: https://travis-ci.org/divio/djangocms-audio
.. |coverage| image:: https://codecov.io/gh/divio/djangocms-audio/branch/master/graph/badge.svg
:target: https://codecov.io/gh/divio/djangocms-audio
.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg
:target: https://pypi.org/project/djangocms-audio/
.. |django| image:: https://img.shields.io/badge/django-2.2,%203.0,%203.1-blue.svg
:target: https://www.djangoproject.com/
.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg
:target: https://www.django-cms.org/
Raw data
{
"_id": null,
"home_page": "https://github.com/django-cms/djangocms-audio",
"name": "djangocms-audio",
"maintainer": "Django CMS Association and contributors",
"docs_url": null,
"requires_python": "",
"maintainer_email": "info@django-cms.org",
"keywords": "",
"author": "Divio AG",
"author_email": "info@divio.com",
"download_url": "https://files.pythonhosted.org/packages/6d/15/60b72b6ed96320666fb68dc78a916913ae5b1fc870f9dabdaff5a49e8f66/djangocms-audio-2.1.0.tar.gz",
"platform": null,
"description": "================\ndjango CMS Audio\n================\n\n|pypi| |build| |coverage|\n\n**django CMS Audio** is a set of plugins for `django CMS <http://django-cms.org>`_\nthat allow you to publish audio files on your site (using an HTML5 player by default,\nbut you can override this in your own templates if required).\n\nIt uses files managed by `Django Filer <https://github.com/divio/django-filer>`_.\nThe plugins allow you to select a single file or an entire folder of files.\n\n.. note:: \n\n This project is considered 3rd party (no supervision by the `django CMS Association <https://www.django-cms.org/en/about-us/>`_). Join us on `Slack <https://www.django-cms.org/slack/>`_ for more information.\n\n.. image:: preview.gif\n\n\n*******************************************\nContribute to this project and win rewards\n*******************************************\n\nBecause this is a an open-source project, we welcome everyone to\n`get involved in the project <https://www.django-cms.org/en/contribute/>`_ and\n`receive a reward <https://www.django-cms.org/en/bounty-program/>`_ for their contribution. \nBecome part of a fantastic community and help us make django CMS the best CMS in the world. \n\nWe'll be delighted to receive your\nfeedback in the form of issues and pull requests. Before submitting your\npull request, please review our `contribution guidelines\n<http://docs.django-cms.org/en/latest/contributing/index.html>`_.\n\nWe're grateful to all contributors who have helped create and maintain this package.\nContributors are listed at the `contributors <https://github.com/django-cms/djangocms-audio/graphs/contributors>`_\nsection.\n\nDocumentation\n=============\n\nSee ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-audio/blob/master/setup.py>`_\nfile for additional dependencies:\n\n|python| |django| |djangocms|\n\n* Django Filer 1.7 or higher\n\nMake sure `django-filer <http://django-filer.readthedocs.io/en/latest/installation.html>`_\nis installed and configured appropriately.\n\n\nInstallation\n------------\n\nFor a manual install:\n\n* run ``pip install djangocms-audio``\n* add ``djangocms_audio`` to your ``INSTALLED_APPS``\n* run ``python manage.py migrate djangocms_audio``\n\n\nConfiguration\n-------------\n\nNote that the provided templates are very minimal by design. You are encouraged\nto adapt and override them to your project's requirements.\n\nThis addon provides a ``default`` template for all instances. You can provide\nadditional template choices by adding a ``DJANGOCMS_AUDIO_TEMPLATES``\nsetting::\n\n DJANGOCMS_AUDIO_TEMPLATES = [\n ('feature', _('Featured Version')),\n ]\n\nYou'll need to create the `feature` folder inside ``templates/djangocms_audio/``\notherwise you will get a *template does not exist* error. You can do this by\ncopying the ``default`` folder inside that directory and renaming it to\n``feature``.\n\n``MP3`` and ``OGG`` files are allowed by default. We recommend using ``MP3``\nas it's supported across all major browsers. You can change the default\nsetting by overriding::\n\n DJANGOCMS_AUDIO_ALLOWED_EXTENSIONS = ['mp3', 'ogg', 'wav']\n\n\nRunning Tests\n-------------\n\nYou can run tests by executing::\n\n virtualenv env\n source env/bin/activate\n pip install -r tests/requirements.txt\n python setup.py test\n\n\n.. |pypi| image:: https://badge.fury.io/py/djangocms-audio.svg\n :target: http://badge.fury.io/py/djangocms-audio\n.. |build| image:: https://travis-ci.org/divio/djangocms-audio.svg?branch=master\n :target: https://travis-ci.org/divio/djangocms-audio\n.. |coverage| image:: https://codecov.io/gh/divio/djangocms-audio/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/divio/djangocms-audio\n\n.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg\n :target: https://pypi.org/project/djangocms-audio/\n.. |django| image:: https://img.shields.io/badge/django-2.2,%203.0,%203.1-blue.svg\n :target: https://www.djangoproject.com/\n.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg\n :target: https://www.django-cms.org/\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Adds audio plugin to django CMS.",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/django-cms/djangocms-audio"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "878ecfc09e29a54a9aca4310b3b74303c219abadad1c9d81562be6f3d78c44c2",
"md5": "0a29240bba5b5f69c55c281e9a0aebb4",
"sha256": "7987d4abf560f023e485eb4e39884cef9c0a96ff260ec6e058d676896a71fd82"
},
"downloads": -1,
"filename": "djangocms_audio-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a29240bba5b5f69c55c281e9a0aebb4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 27110,
"upload_time": "2023-06-29T13:09:57",
"upload_time_iso_8601": "2023-06-29T13:09:57.846198Z",
"url": "https://files.pythonhosted.org/packages/87/8e/cfc09e29a54a9aca4310b3b74303c219abadad1c9d81562be6f3d78c44c2/djangocms_audio-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d1560b72b6ed96320666fb68dc78a916913ae5b1fc870f9dabdaff5a49e8f66",
"md5": "cbe84ff1e6fa9c349f71658831735519",
"sha256": "84f99b18c7f8f4b7608adb8d24f38e614a9f389be336c7a10004f06aa7a17fac"
},
"downloads": -1,
"filename": "djangocms-audio-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "cbe84ff1e6fa9c349f71658831735519",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17591,
"upload_time": "2023-06-29T13:09:59",
"upload_time_iso_8601": "2023-06-29T13:09:59.388315Z",
"url": "https://files.pythonhosted.org/packages/6d/15/60b72b6ed96320666fb68dc78a916913ae5b1fc870f9dabdaff5a49e8f66/djangocms-audio-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-29 13:09:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-cms",
"github_project": "djangocms-audio",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "djangocms-audio"
}
JSON
