Metadata-Version: 2.1
Name: dash-recording-components
Version: 1.0.0
Summary: A Dash component for recording audio from the browser
License: MIT
Author: Daniel Cahall
Author-email: danielenricocahall@gmail.com
Requires-Python: >=3.8,<=3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: dash (>=2.14.1,<3.0.0)
Description-Content-Type: text/markdown


# Overview
A Dash component for recording audio. The component is built using [microphone-stream](https://www.npmjs.com/package/microphone-stream).

# Installation
Simply install the package using pip:
```shell
pip install dash-recording-components
```


# Development and Contributing
- Create a Poetry environment and install all required dependencies: `poetry install --dev`
- Install [webpack](https://webpack.js.org/)
- Install `npm` 
- `npm install` to install the dependencies
- Build the js files: `npm run build:js`
- Build the Dash components (Python modules): `npm run build:py`

Changes in the React components  (`src/lib/components`), such as exposing new properties or updating audio collection logic require running steps 5 and 6 above. The existing autogenerated Python modules should not be edited.


# Example
For a simple example of how to use the `AudioRecorder` component, run `app.py`. It's nothing fancy, but it should give you an idea of how to use the component.


