| Name | shinymedia JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Extends the Shiny web framework with controls for multimedia input/output. |
| upload_time | 2024-07-16 18:26:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Copyright 2024 Posit Software, PBC Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
video
audio
shiny
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# shinymedia
**shinymedia** is a Python package that provides [Shiny](https://shiny.posit.co/py/) UI controls for recording and playing back media.
At this time it includes two components:
- `shinymedia.input_video_clip` for recording video clips using attached cameras
- `shinymedia.audio_spinner` for playing back audio with a spinning visualization
You can see these two components in action together in our [live demo](https://jcheng.shinyapps.io/multimodal/) ([source code](https://github.com/jcheng5/multimodal)), or keep reading.
## Installation
From PyPI:
```bash
pip install shinymedia
```
Or to install the latest from GitHub:
```bash
pip install "shinymedia @ git+https://github.com/posit-dev/shinymedia?subdirectory=python-package"
```
## Development
### JavaScript
To develop the JavaScript components, you will need to have Node.js installed. Then, `npm install` in this directory to install dependencies.
After making changes to the TypeScript code in srcts, run `npm run build` to compile to JavaScript (or `npm run watch` to automatically recompile on changes). You can also run `npm run typecheck` to check for TypeScript type errors.
### Python
To develop the Python package, you can install it in editable mode:
```bash
pip install -e python-package
```
### Documentation
To build the documentation, first install additional dependencies:
```bash
pip install -e "python-package[docs]"
```
Then:
```bash
cd quarto
quartodoc build # Build reference docs
quarto preview # Serve the docs locally
```
Raw data
{
"_id": null,
"home_page": null,
"name": "shinymedia",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "video, audio, shiny",
"author": null,
"author_email": "Joe Cheng <joe@posit.co>",
"download_url": "https://files.pythonhosted.org/packages/60/d8/4b7aab701d7c9d855bc7e5fbafaa630dd2c07c8161816dcf657bb562e3b3/shinymedia-0.1.1.tar.gz",
"platform": null,
"description": "# shinymedia\n\n**shinymedia** is a Python package that provides [Shiny](https://shiny.posit.co/py/) UI controls for recording and playing back media.\n\nAt this time it includes two components:\n\n- `shinymedia.input_video_clip` for recording video clips using attached cameras\n- `shinymedia.audio_spinner` for playing back audio with a spinning visualization\n\nYou can see these two components in action together in our [live demo](https://jcheng.shinyapps.io/multimodal/) ([source code](https://github.com/jcheng5/multimodal)), or keep reading.\n\n## Installation\n\nFrom PyPI:\n\n```bash\npip install shinymedia\n```\n\nOr to install the latest from GitHub:\n\n```bash\npip install \"shinymedia @ git+https://github.com/posit-dev/shinymedia?subdirectory=python-package\"\n```\n\n## Development\n\n### JavaScript\n\nTo develop the JavaScript components, you will need to have Node.js installed. Then, `npm install` in this directory to install dependencies.\n\nAfter making changes to the TypeScript code in srcts, run `npm run build` to compile to JavaScript (or `npm run watch` to automatically recompile on changes). You can also run `npm run typecheck` to check for TypeScript type errors.\n\n### Python\n\nTo develop the Python package, you can install it in editable mode:\n\n```bash\npip install -e python-package\n```\n\n### Documentation\n\nTo build the documentation, first install additional dependencies:\n\n```bash\npip install -e \"python-package[docs]\"\n```\n\nThen:\n\n```bash\ncd quarto\nquartodoc build # Build reference docs\nquarto preview # Serve the docs locally\n```\n",
"bugtrack_url": null,
"license": "Copyright 2024 Posit Software, PBC Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Extends the Shiny web framework with controls for multimedia input/output.",
"version": "0.1.1",
"project_urls": {
"documentation": "https://posit-dev.github.io/shinymedia/",
"homepage": "https://github.com/posit-dev/shinymedia"
},
"split_keywords": [
"video",
" audio",
" shiny"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c63b48d8550dce52a7e544f50c091ae834925f5c4f58f9e77c40ee2882d65037",
"md5": "28ce1444913d7415fe469c85ba97ec55",
"sha256": "fe57ebaebfa2d684660d5d14af3f24dc033dbe1fc5abbe5e902cf6452b996839"
},
"downloads": -1,
"filename": "shinymedia-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28ce1444913d7415fe469c85ba97ec55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13156,
"upload_time": "2024-07-16T18:26:46",
"upload_time_iso_8601": "2024-07-16T18:26:46.898896Z",
"url": "https://files.pythonhosted.org/packages/c6/3b/48d8550dce52a7e544f50c091ae834925f5c4f58f9e77c40ee2882d65037/shinymedia-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60d84b7aab701d7c9d855bc7e5fbafaa630dd2c07c8161816dcf657bb562e3b3",
"md5": "d4f2098e8b43e75a7d5711748199a120",
"sha256": "bcf9b0454b2ee2abdb522be3c1e58e9cf03cf5517049fd487f602dc417e68f5d"
},
"downloads": -1,
"filename": "shinymedia-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d4f2098e8b43e75a7d5711748199a120",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14010,
"upload_time": "2024-07-16T18:26:48",
"upload_time_iso_8601": "2024-07-16T18:26:48.333388Z",
"url": "https://files.pythonhosted.org/packages/60/d8/4b7aab701d7c9d855bc7e5fbafaa630dd2c07c8161816dcf657bb562e3b3/shinymedia-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 18:26:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "posit-dev",
"github_project": "shinymedia",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shinymedia"
}
