| Name | ipyaudioworklet JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | A Jupyter Widget for Web Audio Recording using Audio Worklet |
| upload_time | 2024-11-04 15:54:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | Copyright (c) 2023 Sunao Hara All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
ipython
jupyter
widgets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# ipyaudioworklet
<!--
[](https://travis-ci.org/naoh16/ipyaudioworklet)
[](https://codecov.io/gh/naoh16/ipyaudioworklet)
-->
A Jupyter Widget for Web Audio Recording using Audio Worklet
This extension will be enable us to record PCM audio using AudioWorkletNode of Web Audio API.
For the security constraints of major web-browsers, you need to run JupyterLab with HTTPS context.
## Installation
You can install using `pip`:
### Prebuild
```bash
pip install -U ipyaudioworklet
```
or, you may find some prebuilt packages in GitHub releases. Eg.
```bash
pip install -U https://github.com/naoh16/ipyaudioworklet/releases/download/v0.1.3/ipyaudioworklet-0.1.3-py3-none-any.whl
```
### Self-build from master branch
```bash
pip install git+https://github.com/naoh16/ipyaudioworklet.git
```
## Usage
### quickstart
- You can see the interface as following cell:
```python
import ipyaudioworklet as ipyaudio
recorder = ipyaudio.AudioRecorder()
recorder
```
- Then you can find three buttons in the widget.
- `[Boot RECORDER]` Button / `recorder.run()`
- As first, you need to push the button to boot up the recorder.
- Please allow your web browser access to your PC's microphone.
- `[Record]` Button / `recorder.resume()`
- You can record audio.
- `[Stop]` Button / `recorder.suspend()`
- You can stop the recording.
- audio control (HTML5's ``<audio>``)
- You can preview the recroded sound.
- You may download the sound as WAV file through option menu of the control. (depend on your web browser)
### Examples
See examples: [examples/introduction.ipynb](examples/introduction.ipynb)
You can try them on Binder:
[](https://mybinder.org/v2/gh/naoh16/ipyaudioworklet/main?labpath=examples)
## For developers and Audio/Sound reserchers!!
Please check the following files. They are the core modules of this extension.
- JupyterLab/ipywidgets interface
- [src/widgets.ts](src/widgets.ts) ... Frontend of the widget
- [ipyaudioworklet/audio.py](ipyaudioworklet/audio.py) ... Backend of the widget
- Audio Recording
- [src/audio.ts](src/audio.ts) ... Utility functions using Web Audio API
- [src/_static/audio-processor.js](src/_static/audio-processor.js) ... AudioWorkletNode definition. This node is ping pong the recording audio fragments to the callback function defined in `audio.ts`.
---
TODO: The following lines are not modified from cookie-cutter templates.
### Miscs
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
the nbextension:
```bash
jupyter nbextension enable --py [--sys-prefix|--user|--system] ipyaudioworklet
```
## Development Installation
Create a dev environment:
```bash
conda create -n ipyaudioworklet-dev -c conda-forge nodejs yarn python jupyterlab
conda activate ipyaudioworklet-dev
```
Install the python. This will also build the TS package.
```bash
pip install -e ".[test, examples]"
```
When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend. For lab, this is done by the command:
```
jupyter labextension develop --overwrite .
yarn run build
```
For classic notebook, you need to run:
```
jupyter nbextension install --sys-prefix --symlink --overwrite --py ipyaudioworklet
jupyter nbextension enable --sys-prefix --py ipyaudioworklet
```
Note that the `--symlink` flag doesn't work on Windows, so you will here have to run
the `install` command every time that you rebuild your extension. For certain installations
you might also need another flag instead of `--sys-prefix`, but we won't cover the meaning
of those flags here.
### How to see your changes
#### Typescript:
If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
terminals to watch for changes in the extension's source and automatically rebuild the widget.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab
```
After a change wait for the build to finish and then refresh your browser and the changes should take effect.
#### Python:
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
## Updating the version
To update the version, install tbump and use it to bump the version.
By default it will also create a tag.
```bash
pip install tbump
tbump <new-version>
```
## Build sdist and wheel
```bash
hatch build
```
## Publish public repository and CDNs
### PyPI
```bash
pip install twine
twine upload --repository testpypi dist/ipyaudioworklet-<new-version>*whl
twine upload --repository pypi dist/ipyaudioworklet-<new-version>*whl
```
### NPM
```bash
npm publish --access public
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ipyaudioworklet",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "IPython, Jupyter, Widgets",
"author": null,
"author_email": "Sunao Hara <sunao.hara@gmail.com>",
"download_url": null,
"platform": null,
"description": "\n# ipyaudioworklet\n\n<!--\n[](https://travis-ci.org/naoh16/ipyaudioworklet)\n[](https://codecov.io/gh/naoh16/ipyaudioworklet)\n-->\n\nA Jupyter Widget for Web Audio Recording using Audio Worklet\n\nThis extension will be enable us to record PCM audio using AudioWorkletNode of Web Audio API.\nFor the security constraints of major web-browsers, you need to run JupyterLab with HTTPS context.\n\n\n\n## Installation\n\nYou can install using `pip`:\n\n### Prebuild\n\n```bash\npip install -U ipyaudioworklet\n```\n\nor, you may find some prebuilt packages in GitHub releases. Eg.\n\n```bash\npip install -U https://github.com/naoh16/ipyaudioworklet/releases/download/v0.1.3/ipyaudioworklet-0.1.3-py3-none-any.whl\n```\n\n### Self-build from master branch\n\n```bash\npip install git+https://github.com/naoh16/ipyaudioworklet.git\n```\n\n## Usage\n\n### quickstart\n\n- You can see the interface as following cell:\n\n ```python\n import ipyaudioworklet as ipyaudio\n \n recorder = ipyaudio.AudioRecorder()\n recorder\n ```\n\n- Then you can find three buttons in the widget.\n\n - `[Boot RECORDER]` Button / `recorder.run()`\n - As first, you need to push the button to boot up the recorder.\n - Please allow your web browser access to your PC's microphone.\n - `[Record]` Button / `recorder.resume()`\n - You can record audio.\n - `[Stop]` Button / `recorder.suspend()`\n - You can stop the recording.\n - audio control (HTML5's ``<audio>``)\n - You can preview the recroded sound.\n - You may download the sound as WAV file through option menu of the control. (depend on your web browser)\n\n### Examples\n\nSee examples: [examples/introduction.ipynb](examples/introduction.ipynb)\n\nYou can try them on Binder:\n[](https://mybinder.org/v2/gh/naoh16/ipyaudioworklet/main?labpath=examples)\n\n\n## For developers and Audio/Sound reserchers!!\n\nPlease check the following files. They are the core modules of this extension.\n\n- JupyterLab/ipywidgets interface\n - [src/widgets.ts](src/widgets.ts) ... Frontend of the widget\n - [ipyaudioworklet/audio.py](ipyaudioworklet/audio.py) ... Backend of the widget\n- Audio Recording\n - [src/audio.ts](src/audio.ts) ... Utility functions using Web Audio API\n - [src/_static/audio-processor.js](src/_static/audio-processor.js) ... AudioWorkletNode definition. This node is ping pong the recording audio fragments to the callback function defined in `audio.ts`.\n\n---\n\nTODO: The following lines are not modified from cookie-cutter templates.\n\n### Miscs\n\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\nthe nbextension:\n```bash\njupyter nbextension enable --py [--sys-prefix|--user|--system] ipyaudioworklet\n```\n\n## Development Installation\n\nCreate a dev environment:\n```bash\nconda create -n ipyaudioworklet-dev -c conda-forge nodejs yarn python jupyterlab\nconda activate ipyaudioworklet-dev\n```\n\nInstall the python. This will also build the TS package.\n```bash\npip install -e \".[test, examples]\"\n```\n\nWhen developing your extensions, you need to manually enable your extensions with the\nnotebook / lab frontend. For lab, this is done by the command:\n\n```\njupyter labextension develop --overwrite .\nyarn run build\n```\n\nFor classic notebook, you need to run:\n\n```\njupyter nbextension install --sys-prefix --symlink --overwrite --py ipyaudioworklet\njupyter nbextension enable --sys-prefix --py ipyaudioworklet\n```\n\nNote that the `--symlink` flag doesn't work on Windows, so you will here have to run\nthe `install` command every time that you rebuild your extension. For certain installations\nyou might also need another flag instead of `--sys-prefix`, but we won't cover the meaning\nof those flags here.\n\n### How to see your changes\n#### Typescript:\nIf you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different\nterminals to watch for changes in the extension's source and automatically rebuild the widget.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\nyarn run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nAfter a change wait for the build to finish and then refresh your browser and the changes should take effect.\n\n#### Python:\nIf you make a change to the python code then you will need to restart the notebook kernel to have it take effect.\n\n## Updating the version\n\nTo update the version, install tbump and use it to bump the version.\nBy default it will also create a tag.\n\n```bash\npip install tbump\ntbump <new-version>\n```\n\n## Build sdist and wheel\n\n```bash\nhatch build\n```\n\n## Publish public repository and CDNs\n\n### PyPI\n\n```bash\npip install twine\ntwine upload --repository testpypi dist/ipyaudioworklet-<new-version>*whl\ntwine upload --repository pypi dist/ipyaudioworklet-<new-version>*whl\n```\n\n### NPM\n\n```bash\nnpm publish --access public\n```\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023 Sunao Hara All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A Jupyter Widget for Web Audio Recording using Audio Worklet",
"version": "0.5.1",
"project_urls": {
"Homepage": "https://github.com/naoh16/ipyaudioworklet"
},
"split_keywords": [
"ipython",
" jupyter",
" widgets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c09ea6ed3b4df25587f01bd14d04cd823a0958795bfd0c4a712d12b0a041ba1",
"md5": "41ddf65854c371272147a020d55fac12",
"sha256": "a35bbe2c246b2dd8f6e9762a20f8e3f57914b5f4837198f39ab93e7d873e35c3"
},
"downloads": -1,
"filename": "ipyaudioworklet-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41ddf65854c371272147a020d55fac12",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 595856,
"upload_time": "2024-11-04T15:54:54",
"upload_time_iso_8601": "2024-11-04T15:54:54.042468Z",
"url": "https://files.pythonhosted.org/packages/5c/09/ea6ed3b4df25587f01bd14d04cd823a0958795bfd0c4a712d12b0a041ba1/ipyaudioworklet-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 15:54:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "naoh16",
"github_project": "ipyaudioworklet",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ipyaudioworklet"
}
