jupyterlite-p5-kernel


Namejupyterlite-p5-kernel JSON
Version 0.1.1 PyPI version JSON
download
home_page
Summary
upload_time2023-02-10 14:48:26
maintainer
docs_urlNone
authorJupyterLite Contributors
requires_python>=3.7
licenseBSD 3-Clause License Copyright (c) 2021, JupyterLite Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * 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
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # jupyterlite-p5-kernel

[![Github Actions Status](https://github.com/jupyterlite/p5-kernel/workflows/Build/badge.svg)](https://github.com/jupyterlite/p5-kernel/actions/workflows/build.yml)
[![JupyterLite](https://jupyterlite.rtfd.io/en/latest/_static/badge-launch.svg)](https://jupyterlite-p5-kernel.readthedocs.io/en/latest/lite/lab)

A p5.js kernel for JupyterLite.

![image](https://user-images.githubusercontent.com/591645/135318337-8e63861c-c598-48db-8c90-2c86d3a8936b.png)

## Requirements

- [JupyterLite](https://github.com/jupyterlite/jupyterlite) `0.1.0b18+`

## Install

This JupyterLite kernel can be installed as a federated server extension.

```bash
# Install the kernel
pip install jupyterlite-p5-kernel

# Build a new JupyterLite site
jupyter lite build
```

See the JupyterLite documentation for more information on how to build sites and include additional extensions: https://jupyterlite.readthedocs.io/en/latest/howto/index.html

## Uninstall

```bash
pip uninstall jupyterlite-p5-kernel
```

## Contributing

### Development install

```bash
# Clone the repo to your local environment
# Change directory to the fork directory

# create a new enviroment
mamba create --name jupyterlite-p5-kernel -c conda-forge python=3.9 yarn jupyterlab
mamba activate jupyterlite-p5-kernel

# Install package in development mode
python -m pip install -e .

# Link your development version of the extension with JupyterLab
jlpm run install:extension

# Rebuild the extension Typescript source after making changes
jlpm run build
```

The extension should be linked to `PREFIX/share/jupyter/labextensions` and can be picked up by `jupyterlite`:

```bash
# Install jupyterlite
python -m pip install jupyterlite

# Build a new JupyterLite site
jupyter lite build

# Serve the site
jupyter lite serve

# Launch a browser to the Jupyterlite server url
python -m webbrowser http://localhost:8000/
```

## References

### p5.js

- Processing > ProcessingJS > p5.js
  https://en.wikipedia.org/wiki/Processing#p5.js
- https://github.com/processing/p5.js
- https://p5js.org/learn/
- https://p5js.org/reference/ API docs
- https://p5js.org/examples/
  - https://p5js.org/examples/math-additive-wave.html
  - https://p5js.org/examples/interaction-wavemaker.html
- https://p5js.org/examples/objects-objects.html
- https://github.com/processing/p5.js/wiki/Beyond-the-canvas#creating-html-images
- https://github.com/processing/p5.js/wiki/Getting-started-with-WebGL-in-p5#introducing-webgl-in-p5js
- Summer of Code
  https://github.com/processing/p5.js/wiki#google-summer-of-code-and-processing-fellowships
- Season of Docs
  https://github.com/processing/p5.js/wiki#season-of-docs

#### p5.js Learning Resources

- https://github.com/processing/p5.js/wiki/Educational-Resources
- https://www.khanacademy.org/computing/computer-programming/pjs-documentation
  - https://www.khanacademy.org/computing/computer-programming/programming-games-visualizations/advanced-development-tools/a/using-processingjs-outside-khan-academy
- Khan Academy > Computer Programming > "Intro to JS: Drawing & Animation"
  https://www.khanacademy.org/computing/computer-programming/programming
  - https://github.com/processing/p5.js/wiki/Processing-transition#overview-of-differences
  - https://github.com/processing/p5.js/wiki/p5.js-overview#how-is-this-different-than-processingjs
- Khan Academy > Computing > Pixar in a Box
  https://www.khanacademy.org/computing/pixar
  - https://www.khanacademy.org/computing/pixar/simulation#hair-simulation-code
  - https://www.khanacademy.org/computing/pixar/pixar-rigging#code-character
  - https://en.wikipedia.org/wiki/Lorentz_transformation Rotation about a point other than the origin
  - https://en.wikipedia.org/wiki/Quaternion

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "jupyterlite-p5-kernel",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "JupyterLite Contributors",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/b9/5c/de002417d876323b22ed35d01737a0cff9871eff1c566dc8fd6dfc222a32/jupyterlite_p5_kernel-0.1.1.tar.gz",
    "platform": null,
    "description": "# jupyterlite-p5-kernel\n\n[![Github Actions Status](https://github.com/jupyterlite/p5-kernel/workflows/Build/badge.svg)](https://github.com/jupyterlite/p5-kernel/actions/workflows/build.yml)\n[![JupyterLite](https://jupyterlite.rtfd.io/en/latest/_static/badge-launch.svg)](https://jupyterlite-p5-kernel.readthedocs.io/en/latest/lite/lab)\n\nA p5.js kernel for JupyterLite.\n\n![image](https://user-images.githubusercontent.com/591645/135318337-8e63861c-c598-48db-8c90-2c86d3a8936b.png)\n\n## Requirements\n\n- [JupyterLite](https://github.com/jupyterlite/jupyterlite) `0.1.0b18+`\n\n## Install\n\nThis JupyterLite kernel can be installed as a federated server extension.\n\n```bash\n# Install the kernel\npip install jupyterlite-p5-kernel\n\n# Build a new JupyterLite site\njupyter lite build\n```\n\nSee the JupyterLite documentation for more information on how to build sites and include additional extensions: https://jupyterlite.readthedocs.io/en/latest/howto/index.html\n\n## Uninstall\n\n```bash\npip uninstall jupyterlite-p5-kernel\n```\n\n## Contributing\n\n### Development install\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the fork directory\n\n# create a new enviroment\nmamba create --name jupyterlite-p5-kernel -c conda-forge python=3.9 yarn jupyterlab\nmamba activate jupyterlite-p5-kernel\n\n# Install package in development mode\npython -m pip install -e .\n\n# Link your development version of the extension with JupyterLab\njlpm run install:extension\n\n# Rebuild the extension Typescript source after making changes\njlpm run build\n```\n\nThe extension should be linked to `PREFIX/share/jupyter/labextensions` and can be picked up by `jupyterlite`:\n\n```bash\n# Install jupyterlite\npython -m pip install jupyterlite\n\n# Build a new JupyterLite site\njupyter lite build\n\n# Serve the site\njupyter lite serve\n\n# Launch a browser to the Jupyterlite server url\npython -m webbrowser http://localhost:8000/\n```\n\n## References\n\n### p5.js\n\n- Processing > ProcessingJS > p5.js\n  https://en.wikipedia.org/wiki/Processing#p5.js\n- https://github.com/processing/p5.js\n- https://p5js.org/learn/\n- https://p5js.org/reference/ API docs\n- https://p5js.org/examples/\n  - https://p5js.org/examples/math-additive-wave.html\n  - https://p5js.org/examples/interaction-wavemaker.html\n- https://p5js.org/examples/objects-objects.html\n- https://github.com/processing/p5.js/wiki/Beyond-the-canvas#creating-html-images\n- https://github.com/processing/p5.js/wiki/Getting-started-with-WebGL-in-p5#introducing-webgl-in-p5js\n- Summer of Code\n  https://github.com/processing/p5.js/wiki#google-summer-of-code-and-processing-fellowships\n- Season of Docs\n  https://github.com/processing/p5.js/wiki#season-of-docs\n\n#### p5.js Learning Resources\n\n- https://github.com/processing/p5.js/wiki/Educational-Resources\n- https://www.khanacademy.org/computing/computer-programming/pjs-documentation\n  - https://www.khanacademy.org/computing/computer-programming/programming-games-visualizations/advanced-development-tools/a/using-processingjs-outside-khan-academy\n- Khan Academy > Computer Programming > \"Intro to JS: Drawing & Animation\"\n  https://www.khanacademy.org/computing/computer-programming/programming\n  - https://github.com/processing/p5.js/wiki/Processing-transition#overview-of-differences\n  - https://github.com/processing/p5.js/wiki/p5.js-overview#how-is-this-different-than-processingjs\n- Khan Academy > Computing > Pixar in a Box\n  https://www.khanacademy.org/computing/pixar\n  - https://www.khanacademy.org/computing/pixar/simulation#hair-simulation-code\n  - https://www.khanacademy.org/computing/pixar/pixar-rigging#code-character\n  - https://en.wikipedia.org/wiki/Lorentz_transformation Rotation about a point other than the origin\n  - https://en.wikipedia.org/wiki/Quaternion\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2021, JupyterLite Contributors All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  * 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.  * 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": "",
    "version": "0.1.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ba5f4d56c4f5eb7705f95623039add0a52c9dce3407bf1646ba024d99ff7ec6b",
                "md5": "1f412a766f7d0264211d9e3820dd3c39",
                "sha256": "45d8424e09ca160ce6823bc10180e210400d519e2195fa84af2d8dc08c9a37b2"
            },
            "downloads": -1,
            "filename": "jupyterlite_p5_kernel-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1f412a766f7d0264211d9e3820dd3c39",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 21760,
            "upload_time": "2023-02-10T14:48:24",
            "upload_time_iso_8601": "2023-02-10T14:48:24.335701Z",
            "url": "https://files.pythonhosted.org/packages/ba/5f/4d56c4f5eb7705f95623039add0a52c9dce3407bf1646ba024d99ff7ec6b/jupyterlite_p5_kernel-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b95cde002417d876323b22ed35d01737a0cff9871eff1c566dc8fd6dfc222a32",
                "md5": "9303e06d95ed7a213aa741ce6a5fe765",
                "sha256": "4d73fdab2f7887219b8b958dabda5ac0b09e09db7839b80415379a28224d5036"
            },
            "downloads": -1,
            "filename": "jupyterlite_p5_kernel-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "9303e06d95ed7a213aa741ce6a5fe765",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 241344,
            "upload_time": "2023-02-10T14:48:26",
            "upload_time_iso_8601": "2023-02-10T14:48:26.763782Z",
            "url": "https://files.pythonhosted.org/packages/b9/5c/de002417d876323b22ed35d01737a0cff9871eff1c566dc8fd6dfc222a32/jupyterlite_p5_kernel-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-10 14:48:26",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "jupyterlite-p5-kernel"
}
        
Elapsed time: 0.10638s