https://github.com/posit-dev/shinymedia
https://github.com/posit-dev/shinymedia
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/posit-dev/shinymedia
- Owner: posit-dev
- Created: 2024-06-17T17:58:03.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-11T01:08:38.000Z (4 months ago)
- Last Synced: 2025-03-19T08:41:00.987Z (27 days ago)
- Language: TypeScript
- Homepage: https://posit-dev.github.io/shinymedia/
- Size: 16.4 MB
- Stars: 7
- Watchers: 6
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - posit-dev/shinymedia - (TypeScript)
README
# shinymedia
**shinymedia** is a Python and R package that provides [Shiny](https://shiny.posit.co/py/) UI controls for recording and playing back media.
At this time it includes two components:
- `input_video_clip` for recording video clips using attached cameras
- `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
### Python
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"
```
### R
From CRAN:
```bash
install.packages("shinymedia") # Not published yet
```
Or to install the latest from GitHub:
```bash
pak::pak("posit-dev/shinymedia/r-package")
```
## Documentation
See the [docs website](https://posit-dev.github.io/shinymedia/).
## 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
```