ipyaudio 0.1.0.dev0__py3-none-any.whl

__tests__/index.spec.ts

@@ -0,0 +1,26 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+// Add any needed widget imports here (or from controls)
+// import {} from '@jupyter-widgets/base';
+
+import { createTestModel } from './utils';
+
+import { ExampleModel } from '..';
+
+describe('Example', () => {
+  describe('ExampleModel', () => {
+    it('should be createable', () => {
+      const model = createTestModel(ExampleModel);
+      expect(model).toBeInstanceOf(ExampleModel);
+      expect(model.get('value')).toEqual('Hello World');
+    });
+
+    it('should be createable with a value', () => {
+      const state = { value: 'Foo Bar!' };
+      const model = createTestModel(ExampleModel, state);
+      expect(model).toBeInstanceOf(ExampleModel);
+      expect(model.get('value')).toEqual('Foo Bar!');
+    });
+  });
+});

__tests__/utils.ts

@@ -0,0 +1,119 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import * as widgets from '@jupyter-widgets/base';
+import * as baseManager from '@jupyter-widgets/base-manager';
+import * as services from '@jupyterlab/services';
+
+let numComms = 0;
+
+export class MockComm implements widgets.IClassicComm {
+  constructor() {
+    this.comm_id = `mock-comm-id-${numComms}`;
+    numComms += 1;
+  }
+  on_close(fn: ((x?: any) => void) | null): void {
+    this._on_close = fn;
+  }
+  on_msg(fn: (x?: any) => void): void {
+    this._on_msg = fn;
+  }
+  _process_msg(msg: services.KernelMessage.ICommMsgMsg): void | Promise<void> {
+    if (this._on_msg) {
+      return this._on_msg(msg);
+    } else {
+      return Promise.resolve();
+    }
+  }
+  close(): string {
+    if (this._on_close) {
+      this._on_close();
+    }
+    return 'dummy';
+  }
+  send(): string {
+    return 'dummy';
+  }
+
+  open(): string {
+    return 'dummy';
+  }
+
+  comm_id: string;
+  target_name = 'dummy';
+  _on_msg: ((x?: any) => void) | null = null;
+  _on_close: ((x?: any) => void) | null = null;
+}
+
+export class DummyManager extends baseManager.ManagerBase {
+  constructor() {
+    super();
+    this.el = window.document.createElement('div');
+  }
+
+  display_view(
+    msg: services.KernelMessage.IMessage,
+    view: widgets.DOMWidgetView,
+    options: any
+  ) {
+    // TODO: make this a spy
+    // TODO: return an html element
+    return Promise.resolve(view).then((view) => {
+      this.el.appendChild(view.el);
+      view.on('remove', () => console.log('view removed', view));
+      return view.el;
+    });
+  }
+
+  protected loadClass(
+    className: string,
+    moduleName: string,
+    moduleVersion: string
+  ): Promise<any> {
+    if (moduleName === '@jupyter-widgets/base') {
+      if ((widgets as any)[className]) {
+        return Promise.resolve((widgets as any)[className]);
+      } else {
+        return Promise.reject(`Cannot find class ${className}`);
+      }
+    } else if (moduleName === 'jupyter-datawidgets') {
+      if (this.testClasses[className]) {
+        return Promise.resolve(this.testClasses[className]);
+      } else {
+        return Promise.reject(`Cannot find class ${className}`);
+      }
+    } else {
+      return Promise.reject(`Cannot find module ${moduleName}`);
+    }
+  }
+
+  _get_comm_info() {
+    return Promise.resolve({});
+  }
+
+  _create_comm() {
+    return Promise.resolve(new MockComm());
+  }
+
+  el: HTMLElement;
+
+  testClasses: { [key: string]: any } = {};
+}
+
+export interface Constructor<T> {
+  new (attributes?: any, options?: any): T;
+}
+
+export function createTestModel<T extends widgets.WidgetModel>(
+  constructor: Constructor<T>,
+  attributes?: any
+): T {
+  const id = widgets.uuid();
+  const widget_manager = new DummyManager();
+  const modelOptions = {
+    widget_manager: widget_manager,
+    model_id: id,
+  };
+
+  return new constructor(attributes, modelOptions);
+}

ipyaudio-0.1.0.dev0.dist-info/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2025 Zhendong Peng
+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.

ipyaudio-0.1.0.dev0.dist-info/METADATA

@@ -0,0 +1,149 @@
+Metadata-Version: 2.2
+Name: ipyaudio
+Version: 0.1.0.dev0
+Summary: A Custom Jupyter Widget Library
+Author-email: Zhendong Peng <pzd17@tsinghua.org.cn>
+License: Copyright (c) 2025 Zhendong Peng
+        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.
+        
+Project-URL: Homepage, https://github.com/pengzhendong/ipyaudio
+Keywords: IPython,Jupyter,Widgets
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: ipywidgets>=8.0.0
+Provides-Extra: docs
+Requires-Dist: jupyter_sphinx; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: nbsphinx-link; extra == "docs"
+Requires-Dist: pypandoc; extra == "docs"
+Requires-Dist: pytest_check_links; extra == "docs"
+Requires-Dist: recommonmark; extra == "docs"
+Requires-Dist: sphinx>=1.5; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Provides-Extra: examples
+Provides-Extra: test
+Requires-Dist: nbval; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest>=6.0; extra == "test"
+
+
+# ipyaudio
+
+[![Build Status](https://travis-ci.org/pengzhendong/ipyaudio.svg?branch=master)](https://travis-ci.org/pengzhendong/ipyaudio)
+[![codecov](https://codecov.io/gh/pengzhendong/ipyaudio/branch/master/graph/badge.svg)](https://codecov.io/gh/pengzhendong/ipyaudio)
+
+
+A Custom Jupyter Widget Library
+
+## Installation
+
+You can install using `pip`:
+
+```bash
+pip install ipyaudio
+```
+
+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] ipyaudio
+```
+
+## Development Installation
+
+Create a dev environment:
+```bash
+conda create -n ipyaudio-dev -c conda-forge nodejs python jupyterlab=4.0.11
+conda activate ipyaudio-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 .
+jlpm run build
+```
+
+For classic notebook, you need to run:
+
+```
+jupyter nbextension install --sys-prefix --symlink --overwrite --py ipyaudio
+jupyter nbextension enable --sys-prefix --py ipyaudio
+```
+
+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
+jlpm 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>
+```
+

ipyaudio-0.1.0.dev0.dist-info/RECORD

@@ -0,0 +1,7 @@
+__tests__/index.spec.ts,sha256=cuDep-5X8lJZtivosDeCo5D6NgguX57dWy8L3YDRnWo,829
+__tests__/utils.ts,sha256=505Bow1dDsRjgxW5TaQywQX4tNUCKz4g8IRumd73w4I,2909
+ipyaudio-0.1.0.dev0.dist-info/LICENSE.txt,sha256=-uZ5GSv8HIaOXcLH77MEBajSXj7X8T5N989WfkUFYKc,1498
+ipyaudio-0.1.0.dev0.dist-info/METADATA,sha256=--f7_jllwPtUkv1nrC-fRF28yPBqE61dSOEO3fVRp_s,5601
+ipyaudio-0.1.0.dev0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+ipyaudio-0.1.0.dev0.dist-info/top_level.txt,sha256=ogl6oM0DgCZBVOdY5C6S83CuXc_cgKdnHLgkb741pYU,10
+ipyaudio-0.1.0.dev0.dist-info/RECORD,,

ipyaudio-0.1.0.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ipyaudio-0.1.0.dev0.dist-info/top_level.txt

@@ -0,0 +1 @@
+__tests__