{"_id":"@data-exp-lab/jupyterlab-twitch","_rev":"1-ec54c9297c0e2d513da474c6fd9f43af","name":"@data-exp-lab/jupyterlab-twitch","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@data-exp-lab/jupyterlab-twitch","version":"0.1.0","description":"A JupyterLab extension.","keywords":["jupyter","jupyterlab","jupyterlab-extension"],"homepage":"https://github.com/data-exp-lab/jupyterlab_twitch","bugs":{"url":"https://github.com/data-exp-lab/jupyterlab_twitch/issues"},"license":"BSD-3-Clause","author":{"name":"Matthew Turk"},"main":"lib/index.js","types":"lib/index.d.ts","style":"style/index.css","repository":{"type":"git","url":"https://github.com/data-exp-lab/jupyterlab_twitch.git"},"scripts":{"build":"tsc","build:lib":"tsc","build:all":"jlpm run build:lib","clean":"jlpm run clean:lib","clean:lib":"rimraf lib tsconfig.tsbuildinfo","clean:all":"jlpm run clean:lib","eslint":"eslint . --ext .ts,.tsx --fix","eslint:check":"eslint . --ext .ts,.tsx","prepare":"jlpm run clean && jlpm run build","watch":"tsc -w"},"dependencies":{"@jupyter-widgets/base":"^3.0.0","@jupyterlab/application":"^2.0.0","@jupyterlab/apputils":"^2.1.1","@lumino/coreutils":"^1.5.0","@lumino/widgets":"^1.13.0","@types/node":"^14.0.13"},"devDependencies":{"@typescript-eslint/eslint-plugin":"^2.25.0","@typescript-eslint/parser":"^2.25.0","eslint":"^6.8.0","eslint-config-prettier":"^6.10.1","eslint-plugin-prettier":"^3.1.2","prettier":"1.16.4","rimraf":"^2.6.1","typescript":"~3.7.0"},"sideEffects":["style/*.css"],"jupyterlab":{"extension":"lib/plugin"},"licenseText":"BSD 3-Clause License\n\nCopyright (c) 2020, Matthew Turk All rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n* Redistributions of source code must retain the above copyright notice, this\n  list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright notice,\n  this list of conditions and the following disclaimer in the documentation\n  and/or other materials provided with the distribution.\n\n* Neither the name of the copyright holder nor the names of its\n  contributors may be used to endorse or promote products derived from\n  this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n","_id":"@data-exp-lab/jupyterlab-twitch@0.1.0","dist":{"shasum":"dc9ed6b2b59839bba1c05173605ca601ab366e17","integrity":"sha512-ymDR6PhiPqCFX1qLDEFoh3rXHs4TRicvKliqW8mt7Z1aAHzlmkS+g+sMhWPUuvmu3Aijp7WlVDJKddwPO3k1PA==","tarball":"https://registry.npmjs.org/@data-exp-lab/jupyterlab-twitch/-/jupyterlab-twitch-0.1.0.tgz","fileCount":19,"unpackedSize":39649,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe8k06CRA9TVsSAnZWagAA+XwP/0hSrhBu/G/0X0uEYaOf\n0sbi34467KiM9kDMJi/HdWzJqUN4z+55/4hfTobFjXI9JKkKqQbawN4uYwmQ\n51STe6a3qfyhaIXZyT0nuOxB0FTYY5Q43bj6qb3BNbPYu+UlUj5GGM5qqvFC\nAPvuskz2TJstgGmr0eI4QVnHbznVwZXjvQeOyqG28YEn/wyp4Wwe1ViFBYoo\nMtrlNs6auWgqYKYcjslW4kqtWOwBv01scOct+bwrBuGPfh/lk/k0oOQg5zgI\nvcFB94pj03FgNSKa0lnZUhOe6okA/kYbnoQ3AYNoywfJGNazu/pTfDndn31s\nsg3RTDEcXIdvhA9nN8xB1VYoPKZIMrIxmdJAX2k597RqNiIaTGSwYzWAUbE3\nAOzgyi+9Tgs0X4kBJK1e1+gRlafY6ae/iOnYWgDMT3j9fiO6p3zbWqU0t4bG\nXbFR8inRe1wbFhxndM6qtT5rV6CtWeJbgcikGpkJvvmScWi6EdSdN0wK6DHu\nWIhUNzvu0fQ95g6IdrbDHKv+ZkP1DwHLhBzNqLt6SeWZifkMiPCNUaxon/Je\nOhCrGozHmBdTR4orXVpqvu7o1O/m3j83dOSHiE2uXrPK2KfDAGU5idmLQuO6\n9rdaNlKkPUzvkjQ88N2YLK+qJWuFVOGW5Z78IuC8crq8KskiiBT4hS8tp0cY\nsfqy\r\n=fgzd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDQllA+TysC41SIpKxJN2MEYqLCKs5Or8EsAVxroEYtHgIgHwNxhI0n7CcmXThhoJleNDrUh5f1RjII0kWJp9r+ow8="}]},"maintainers":[{"name":"matthewturk","email":"matthewturk@gmail.com"},{"name":"munkm","email":"madicken.munk@gmail.com"}],"_npmUser":{"name":"matthewturk","email":"matthewturk@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jupyterlab-twitch_0.1.0_1592937785662_0.5721853428857828"},"_hasShrinkwrap":false}},"time":{"created":"2020-06-23T18:43:05.608Z","0.1.0":"2020-06-23T18:43:05.770Z","modified":"2022-04-05T02:50:11.004Z"},"maintainers":[{"name":"matthewturk","email":"matthewturk@gmail.com"},{"name":"munkm","email":"madicken.munk@gmail.com"}],"description":"A JupyterLab extension.","homepage":"https://github.com/data-exp-lab/jupyterlab_twitch","keywords":["jupyter","jupyterlab","jupyterlab-extension"],"repository":{"type":"git","url":"https://github.com/data-exp-lab/jupyterlab_twitch.git"},"author":{"name":"Matthew Turk"},"bugs":{"url":"https://github.com/data-exp-lab/jupyterlab_twitch/issues"},"license":"BSD-3-Clause","readme":"# jupyterlab_twitch\n\n![Github Actions Status](https://github.com/data-exp-lab/jupyterlab_twitch/workflows/Build/badge.svg)\n\nA JupyterLab extension to display Twitch inline.  It provides both a Twitch widget that can be displayed and modified via code, and a standalone Twitch player.\n\nThe goals of the project are to build out a method that allows for students to watch live streaming coding sessions and interact with an instructor from within their Jupyerlab.  At present, it allows for embedding chat and video, but future developments will include deeper integration with chat using [twitch-js](https://github.com/twitch-js/twitch-js/).\n\n## Requirements\n\n* JupyterLab >= 2.0\n\n## Install\n\n```bash\njupyter labextension install @data-exp-lab/jupyterlab-twitch\n```\n\n## Usage\n\nYou can either use the \"Twitch\" option in the command palette, which will prompt you for a Channel, or you can import and use the Twitch widget.  Using the Twitch widget is preferred for most things, but it is also somewhat harder to move around.\n\n```python\nimport jupyterlab_twitch\nplayer = jupyterlab_twitch.TwitchPlayerModel()\nplayer.channel = \"mst3k\"\nplayer.volume = 0.9\ndisplay(player)\n```\n\nOnly a few attributes are exposed on the `TwitchPlayerModel`, and it will likely change its name as chat and other features are added.  Right now you can change the channel, the volume, and mute or unmute.  You can create a new output for the Twitch stream and drag that around, and you can also have multiple going.\n\nThis uses the IFrame embedding library, so may not work on non-localhost domains.\n\nStyle for the widget-based viewer is still a bit clunky, and will be worked on in subsequent versions.\n\n## Contributing\n\n### Install\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Move to jupyterlab_twitch directory\n\n# Install dependencies\njlpm\n# Build Typescript source\njlpm build\n# Link your development version of the extension with JupyterLab\njupyter labextension link .\n# Rebuild Typescript source after making changes\njlpm build\n# Rebuild JupyterLab after making any changes\njupyter lab build\n```\n\nYou can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.\n\n```bash\n# Watch the source directory in another terminal tab\njlpm watch\n# Run jupyterlab in watch mode in one terminal tab\njupyter lab --watch\n```\n\n### Uninstall\n\n```bash\n\njupyter labextension uninstall @data-exp-lab/jupyterlab-twitch\n```\n","readmeFilename":"README.md"}