clld-audio-plugin

Name	clld-audio-plugin JSON
Version	1.2.0 JSON
	download
home_page	https://github.com/clld/clld-audio-plugin
Summary	Render linked audio files in clld apps.
upload_time	2024-04-12 08:49:15
maintainer	None
docs_url	None
author	Robert Forkel
requires_python	None
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # clld-audio-plugin

[![Build Status](https://github.com/clld/clld-audio-plugin/workflows/tests/badge.svg)](https://github.com/clld/clld-audio-plugin/actions?query=workflow%3Atests)
[![PyPI](https://img.shields.io/pypi/v/clld-audio-plugin.svg)](https://pypi.org/project/clld-audio-plugin)

A plugin for the [`clld`](https://pypi.org/project/clld) package.


## Usage

`clld-audio-plugin` provides
- A model class [`clld_audio_plugin.models.Counterpart`](src/clld_audio_plugin/models.py) augmented with an `audio` column to store the URL to an audio file.
- A column for a `DataTable` [`clld_audio_plugin.datatables.AudioCol`](src/clld_audio_plugin/datatables.py) to display objects with an `audio` attribute as audio player.
- A map class [`clld_audio_plugin.maps.ParamMap`](src/clld_audio_plugin/maps.py) specifying a parameter map integrating clld audioplayer functionality.
- Static resources for the configuration/layout of the UI elements contributed by the plugin.

To use map and static resources, include the plugin in your app's `main` function:
```python
    config.include('clld_audio_plugin')
```

To use model and column, just import in your app's `datatables.py` or `models.py` as needed.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/clld/clld-audio-plugin",
    "name": "clld-audio-plugin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Robert Forkel",
    "author_email": "dlce.rdm@eva.mpg.de",
    "download_url": "https://files.pythonhosted.org/packages/95/38/186fe2a868ae5280bd5eeb97f7ab254decc4f6ef326dca081a29ca642e95/clld-audio-plugin-1.2.0.tar.gz",
    "platform": null,
    "description": "# clld-audio-plugin\n\n[![Build Status](https://github.com/clld/clld-audio-plugin/workflows/tests/badge.svg)](https://github.com/clld/clld-audio-plugin/actions?query=workflow%3Atests)\n[![PyPI](https://img.shields.io/pypi/v/clld-audio-plugin.svg)](https://pypi.org/project/clld-audio-plugin)\n\nA plugin for the [`clld`](https://pypi.org/project/clld) package.\n\n\n## Usage\n\n`clld-audio-plugin` provides\n- A model class [`clld_audio_plugin.models.Counterpart`](src/clld_audio_plugin/models.py) augmented with an `audio` column to store the URL to an audio file.\n- A column for a `DataTable` [`clld_audio_plugin.datatables.AudioCol`](src/clld_audio_plugin/datatables.py) to display objects with an `audio` attribute as audio player.\n- A map class [`clld_audio_plugin.maps.ParamMap`](src/clld_audio_plugin/maps.py) specifying a parameter map integrating clld audioplayer functionality.\n- Static resources for the configuration/layout of the UI elements contributed by the plugin.\n\nTo use map and static resources, include the plugin in your app's `main` function:\n```python\n    config.include('clld_audio_plugin')\n```\n\nTo use model and column, just import in your app's `datatables.py` or `models.py` as needed.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Render linked audio files in clld apps.",
    "version": "1.2.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/clld/clld-audio-plugin/issues",
        "Homepage": "https://github.com/clld/clld-audio-plugin"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3228d2079163d0fb81561c9330f71ac462c0a062f08e0cef8534dcaa5378ec63",
                "md5": "9250e26ef33009afe7d4986bc89a425d",
                "sha256": "8a539d1f3103e02aeaf5c8c805ddbcf06be31b11996dadd6a352399e8642991a"
            },
            "downloads": -1,
            "filename": "clld_audio_plugin-1.2.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9250e26ef33009afe7d4986bc89a425d",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 9572,
            "upload_time": "2024-04-12T08:49:12",
            "upload_time_iso_8601": "2024-04-12T08:49:12.550686Z",
            "url": "https://files.pythonhosted.org/packages/32/28/d2079163d0fb81561c9330f71ac462c0a062f08e0cef8534dcaa5378ec63/clld_audio_plugin-1.2.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9538186fe2a868ae5280bd5eeb97f7ab254decc4f6ef326dca081a29ca642e95",
                "md5": "565d1115dcbb45526bac8b455a108470",
                "sha256": "76d70306cd751f01057f7a439a2bdaff73c5b27221a3228abda25978a6845fa7"
            },
            "downloads": -1,
            "filename": "clld-audio-plugin-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "565d1115dcbb45526bac8b455a108470",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9563,
            "upload_time": "2024-04-12T08:49:15",
            "upload_time_iso_8601": "2024-04-12T08:49:15.711586Z",
            "url": "https://files.pythonhosted.org/packages/95/38/186fe2a868ae5280bd5eeb97f7ab254decc4f6ef326dca081a29ca642e95/clld-audio-plugin-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-12 08:49:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "clld",
    "github_project": "clld-audio-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "clld-audio-plugin"
}