{ "info": { "author": "Pierre V. Villeneuve", "author_email": "pierre.villeneuve@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Jupyter", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Multimedia :: Video" ], "description": "# Jupyter Video Widget\n\nThe goal of this project is to develop a custom Jupyter [widget](https://github.com/ipython/ipywidgets) making it easy to play videos (local and remote) via HTML5 video player embededed in a Jupyter Notebook. This widget project was initialized using the very handy Cookiecutter [template](https://github.com/jupyter-widgets/widget-cookiecutter).\n\n\n# Example\n\n![example](example.png)\n\n\n# Install\n\n## Prerequisites\n\nIf not already enabled, you'll need to enable the ipywidgets notebook extension that installs with Jupyter. You can use the command `jupyter nbextension list` to see which (if any) notebook extensions are currently enabled. Enable it with following:\n\n```bash\njupyter nbextension enable --py --sys-prefix widgetsnbextension\n```\n\nAnd if using JupyterLab, additionally run this commands:\n\n```bash\njupyter labextension install @jupyter-widgets/jupyterlab-manager\n\n```\n\n## Standard Installation\n\nUse pip to install:\n\n```bash\npip install Jupyter-Video-Widget\n\njupyter nbextension install --py --sys-prefix jpy_video\njupyter nbextension enable --py --sys-prefix jpy_video\n\njupyter labextension install jupyter-video\n```\n\n\n## Developer Installation\n\n```bash\ngit clone git@github.com:Who8MyLunch/Jupyter_Video_Widget.git\n\ncd Jupyter_Video_Widget\n\npip install -e .\njupyter nbextension install --symlink --py --sys-prefix jpy_video\njupyter nbextension enable --py --sys-prefix jpy_video\n```\n\nDouble check that all extension got installed and enabled:\n\n```bash\njupyter nbextension list\n```\n\n\nAnd if using JupyterLab, additionally run these commands:\n\n```bash\njupyter labextension install @jupyter-widgets/jupyterlab-manager\n```\n\nAnd then run this from this project's js directory:\n\n```bash\njupyter labextension install .\n```\n\n\n# Making Changes to JavaScript Code\n\nJupyter widget development uses [npm]([npm](https://docs.npmjs.com/getting-started/what-is-npm) (Node Package Manager) for handling all the scary JavaScript details. The source code for this project lives in the folder `js` and the npm package is defined by the file `js/package.json`. The actual JavaScript source code for the video widget is contained entirely in the file `js/src/jupyter-video.js`. This is the only JavaScript file you should need edit when working on front-end parts of this project.\n\nAfter making changes to this JavaScript code it must be prepared and packaged into the `static` folder on the Python side of the project. Do this by typing the following command from within the `js` folder:\n\n```bash\nnpm install\n```\n\nSee the links below for more helpful information:\n- https://docs.npmjs.com/cli/install\n- http://stackoverflow.com/questions/19578796/what-is-the-save-option-for-npm-install\n\n\n# File Layout\n\nNote: I found this write-up at npmjs.com very helpful in understanding the recommended folder layout: https://docs.npmjs.com/files/folders.\n\nIn general the name jpy_video is used on the Python side, while jupyter-video is used on the Javascriot side.\n\n - Jupyter_Video_Widget/\n - jpy_video/ All Python code lives here\n - static/ Prepared and packaged JS code ends up here\n - version.py Version number (Python side)\n - video.py Widget Python code\n - server.py Includes http file server with support for byte range requests\n - compound.py\n - monotext_widget.py\n - js/ All original JavaScript code lives here\n - dist/\n - node_modules/\n - src/\n - jupyter-video.js Widget javaScript code\n - embed.js Only edit to update exported module name (e.g. video.js)\n - index.js Only edit to update exported module name (e.g. video.js)\n - extension.js\n - README.md\n - package.json Version number (JS side), author name, email address, github org., etc.\n - webpack.config.js Contains path to static JS folder on the Python side\n - setup.py\n - setup.cfg\n - MANIFEST.in Contains relative path to static folder under jpy_video\n - requirements.txt\n\n\n## Reference Information\n\n- Jupyter widgets documentation:\n - [Jupyter widgets github](https://github.com/ipython/ipywidgets)\n - [Building a custom widget](https://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Custom.html)\n - [Low-level widget tutorial](https://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Low%20Level.html)\n\n- Helpful HTML5 articles:\n - [Good stuff about implementing custom video HTML5 player](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/cross_browser_video_player)\n - [Video player styling](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/Video_player_styling_basics)\n - [Media buffering and seeking, nice example displaying time ranges where video is loaded](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/buffering_seeking_time_ranges)\n - [HTML5 media events](https://www.w3.org/2010/05/video/mediaevents.html)\n\n- More information about HTML5 and video/audio media:\n - https://www.html5rocks.com/en/tutorials/video/basics/\n - https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\n - https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement\n - https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Video_and_audio_content\n - https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery\n - https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_manipulation\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Who8MyLunch/Jupyter_Video_Widget", "keywords": "ipython,jupyter,widgets,video,html5,player", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "jpy-video", "package_url": "https://pypi.org/project/jpy-video/", "platform": "Jupyter", "project_url": "https://pypi.org/project/jpy-video/", "project_urls": { "Homepage": "https://github.com/Who8MyLunch/Jupyter_Video_Widget" }, "release_url": "https://pypi.org/project/jpy-video/0.4.0.dev1/", "requires_dist": [ "ipywidgets (>=7.0.0)", "shortuuid", "ordered-namespace" ], "requires_python": "", "summary": "A Jupyter HTML5 Video Player Widget", "version": "0.4.0.dev1" }, "last_serial": 3747195, "releases": { "0.4.0.dev1": [ { "comment_text": "", "digests": { "md5": "9af2386dcd2b829a9a68fa315b09fa5e", "sha256": "823fb041cf359fe0439eb019b891a34cfa221212c4450e864cee5d96fcbac2a0" }, "downloads": -1, "filename": "jpy_video-0.4.0.dev1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9af2386dcd2b829a9a68fa315b09fa5e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 440208, "upload_time": "2018-04-09T01:01:22", "url": "https://files.pythonhosted.org/packages/23/b7/1d21e48b7365293dfae0f7a177dccdbefde04226feb1a4a612e8c5461937/jpy_video-0.4.0.dev1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f4c5eda382be6b865cd665c78584f4a2", "sha256": "f4cf416454b27aa3c3cb0d48be0b94a2480eb870783d3a3c959851f2cbb4ce22" }, "downloads": -1, "filename": "jpy_video-0.4.0.dev1.tar.gz", "has_sig": false, "md5_digest": "f4c5eda382be6b865cd665c78584f4a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 225578, "upload_time": "2018-04-09T01:01:24", "url": "https://files.pythonhosted.org/packages/89/16/90e09db7652b4e3f81a3a92f80ffa6a08af6957c489aa4437d63824d9d08/jpy_video-0.4.0.dev1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9af2386dcd2b829a9a68fa315b09fa5e", "sha256": "823fb041cf359fe0439eb019b891a34cfa221212c4450e864cee5d96fcbac2a0" }, "downloads": -1, "filename": "jpy_video-0.4.0.dev1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9af2386dcd2b829a9a68fa315b09fa5e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 440208, "upload_time": "2018-04-09T01:01:22", "url": "https://files.pythonhosted.org/packages/23/b7/1d21e48b7365293dfae0f7a177dccdbefde04226feb1a4a612e8c5461937/jpy_video-0.4.0.dev1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f4c5eda382be6b865cd665c78584f4a2", "sha256": "f4cf416454b27aa3c3cb0d48be0b94a2480eb870783d3a3c959851f2cbb4ce22" }, "downloads": -1, "filename": "jpy_video-0.4.0.dev1.tar.gz", "has_sig": false, "md5_digest": "f4c5eda382be6b865cd665c78584f4a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 225578, "upload_time": "2018-04-09T01:01:24", "url": "https://files.pythonhosted.org/packages/89/16/90e09db7652b4e3f81a3a92f80ffa6a08af6957c489aa4437d63824d9d08/jpy_video-0.4.0.dev1.tar.gz" } ] }