{"_id":"@educational-technology-collective/etc_jupyterlab_cell_properties","_rev":"4-c132d9177d4c3d1dbe65ddd6d42ed5d5","name":"@educational-technology-collective/etc_jupyterlab_cell_properties","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.1":{"name":"@educational-technology-collective/etc_jupyterlab_cell_properties","version":"0.1.1","description":"A JupyterLab extension.","keywords":["jupyter","jupyterlab","jupyterlab-extension"],"homepage":"https://github.com/educational-technology-collective/etc_jupyterlab_cell_properties.git","bugs":{"url":"https://github.com/educational-technology-collective/etc_jupyterlab_cell_properties.git/issues"},"license":"BSD-3-Clause","author":{"name":"ETC"},"main":"lib/index.js","types":"lib/index.d.ts","style":"style/index.css","repository":{"type":"git","url":"https://github.com/educational-technology-collective/etc_jupyterlab_cell_properties.git"},"scripts":{"build":"jlpm run build:lib && jlpm run build:labextension:dev","build:prod":"jlpm run clean && jlpm run build:lib && jlpm run build:labextension","build:labextension":"jupyter labextension build .","build:labextension:dev":"jupyter labextension build --development True .","build:lib":"tsc","clean":"jlpm run clean:lib","clean:lib":"rimraf lib tsconfig.tsbuildinfo","clean:labextension":"rimraf etc_jupyterlab_cell_properties/labextension","clean:all":"jlpm run clean:lib && jlpm run clean:labextension","eslint":"eslint . --ext .ts,.tsx --fix","eslint:check":"eslint . --ext .ts,.tsx","install:extension":"jlpm run build","watch":"run-p watch:src watch:labextension","watch:src":"tsc -w","watch:labextension":"jupyter labextension watch ."},"dependencies":{"@jupyterlab/application":"^3.0.0","@jupyterlab/completer":"^3.0.5","@jupyterlab/console":"^3.0.6","@jupyterlab/coreutils":"^5.0.0","@jupyterlab/launcher":"^3.0.5","@jupyterlab/mainmenu":"^3.0.5","@jupyterlab/notebook":"^3.0.7","@jupyterlab/services":"^6.0.5","@jupyterlab/settingregistry":"^3.0.5","@lumino/commands":"^1.12.0","@lumino/signaling":"^1.4.3"},"devDependencies":{"@jupyterlab/builder":"^3.0.0","@typescript-eslint/eslint-plugin":"^4.8.1","@typescript-eslint/parser":"^4.8.1","eslint":"^7.14.0","eslint-config-prettier":"^6.15.0","eslint-plugin-prettier":"^3.1.4","mkdirp":"^1.0.3","npm-run-all":"^4.1.5","prettier":"^2.1.1","rimraf":"^3.0.2","typescript":"~4.1.3"},"sideEffects":["style/*.css","style/index.js"],"styleModule":"style/index.js","jupyterlab":{"discovery":{"server":{"managers":["pip"],"base":{"name":"etc_jupyterlab_cell_properties"}}},"extension":true,"outputDir":"etc_jupyterlab_cell_properties/labextension","schemaDir":"schema"},"jupyter-releaser":{"hooks":{"before-build-npm":["python -m pip install jupyterlab~=3.0","jlpm"]}},"licenseText":"BSD 3-Clause License\n\nCopyright (c) 2020, ETC 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":"@educational-technology-collective/etc_jupyterlab_cell_properties@0.1.1","dist":{"shasum":"bb6716c3d8f19359fc749bc15b707eb7a7ea644e","integrity":"sha512-VzMre5VHs0bxodKh09ulBPkKB5H8Rz+Q5vn/s0ntBsLShoDlCcSVgYAZfH1rQuZuvSiipTBHH6GmnicH7RkG3A==","tarball":"https://registry.npmjs.org/@educational-technology-collective/etc_jupyterlab_cell_properties/-/etc_jupyterlab_cell_properties-0.1.1.tgz","fileCount":11,"unpackedSize":14457,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh2FagCRA9TVsSAnZWagAAb9kP/2Aech3kCHfqBT5pNeMh\nJxC7T9MhOOxq/NNd68IkY4nNmCd24i0o40WKdo7H1/0W5QGS/R0QL+MyyESu\nbgAZGYUxoZg3dy5+Wo06k1KCNrfptZorzQd1u41OJWa+FOmeVA5+qPOnwcOx\n44AlAYzunYoJU8Aub9W8dn6QWtgBZTJx+i27TfsPFK9gF7sJ9NkVi1uuTQA3\nO4X3hPnOKlEkAo/cHeITNnI57c+ctW0nSwgP8MJ43TiVcH1E6sOcdJrBZye6\ngLvoxqknHN35O9obwM9275ztKQ42ZK9gCUHsHIco5V8tN5D75T1+eyv10HzH\niu6dYI9sG3Xj7yDEyffATaYD/J5aS7+9WsuX6+X5X9HmmQxtx7Yx3iY3IOOy\ngJ0kZPe5qY0NyAd1pZdqORPXzs/hQXo7eAWBBqoi8U7C0gagDvZ3aXxYHE54\nuoMFqPYcx2g//1kDmRdyPnSGBvn0GqsXpf+8GYIDlhrI6/9AMEkymsCOdkHG\nMBlP4lStAsWrACtPVZtk4rJCFk9UUPYT1aTkcNibtFEb0enZyGKMXhC90KuC\nrMdKBFgkzxaJ2BMjaRnN5VZ0vYUw2JWjigutAtXn6tXC/Jw2u6q1w/NmfJeZ\ntJyyD1cECiCQpTaDKMiy9/PPv9ND0AYJVxX5EjIKdduJvB5du+amTq8S91FZ\nWDAQ\r\n=8zGJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDbnm91OzmpJnlcyN3zJ4AWlkhT9UwIfXeh8zaqs3yJngIhANOSwBplCnB6V5QRUQlcv6lZ++quLb4keGv2QMR8+Orr"}]},"_npmUser":{"name":"adpatter","email":"adpatter@umich.edu"},"directories":{},"maintainers":[{"name":"cab938","email":"brooksch@umich.edu"},{"name":"adpatter","email":"adpatter@umich.edu"},{"name":"littleaprilfool","email":"aprilwang.zju@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/etc_jupyterlab_cell_properties_0.1.1_1635958929561_0.4602332069938635"},"_hasShrinkwrap":false}},"time":{"created":"2021-11-03T17:02:09.471Z","0.1.1":"2021-11-03T17:02:09.698Z","modified":"2024-01-04T15:15:04.015Z"},"maintainers":[{"email":"mengyanw@umich.edu","name":"mengyanw"},{"email":"luang@umich.edu","name":"lukeanger"},{"email":"brooksch@umich.edu","name":"cab938"},{"email":"adam@farar.net","name":"adpatter"},{"email":"aprilwang.zju@gmail.com","name":"littleaprilfool"}],"description":"A JupyterLab extension.","homepage":"https://github.com/educational-technology-collective/etc_jupyterlab_cell_properties.git","keywords":["jupyter","jupyterlab","jupyterlab-extension"],"repository":{"type":"git","url":"https://github.com/educational-technology-collective/etc_jupyterlab_cell_properties.git"},"author":{"name":"ETC"},"bugs":{"url":"https://github.com/educational-technology-collective/etc_jupyterlab_cell_properties.git/issues"},"license":"BSD-3-Clause","readme":"# ETC JupyterLab Cell Properties\n\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/educational-technology-collective/etc_jupyterlab_cell_properties/main?urlpath=lab)\n\n## Description \n\nThis extension allows for CSS styling to be added to cell metadata.  The specified styling will style the respective cell.\n\n## Usage\n\nIn order to add styling to a cell:  Click on a cell in a Notebook.  Open the Property Inspector in the Right Panel.  Add a property to the Cell Metadata object named `@educational-technology-collective/etc_jupyterlab_cell_properties:plugin` with a value that contains a property named `style`.  Assign an object to the `style` property that contains [JavaScript CSS Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Properties_Reference).  The CSS styling will be applied to the respective cell.\n\n### Example\n\n```json\n{\n    \"@educational-technology-collective/etc_jupyterlab_cell_properties:plugin\": {\n        \"style\": {\n            \"background\": \"#FFCB05\",\n            \"border\": \"solid #00274B 10px\"\n        },\n        \"tags\": []\n    },\n    \"tags\": []\n}\n```\n\n## Requirements\n\n* JupyterLab >= 3.0\n\n## Install\n\nTo install the extension:\n\nInstall the Python build package (https://pypi.org/project/build/).\n\n```bash\npip install build\n```\n\nClone to repository.\n\n```bash\ngit clone https://github.com/educational-technology-collective/etc_jupyterlab_cell_properties.git\n```\n\nor,\n\n```bash\ngit clone git@github.com:educational-technology-collective/etc_jupyterlab_cell_properties.git\n```\n\nChange the directory into the repository.\n\n```bash\ncd etc_jupyterlab_cell_properties\n```\n\n**The following instructions assume that your current working directory is the base directory of the repository.**\n\nNext build the extension according to the instructions given in the [documentation](https://jupyterlab.readthedocs.io/en/stable/extension/extension_tutorial.html#packaging-your-extension).  The instructions are summarized below:\n\nCreate a wheel (.whl) package in the `dist` directory.\n\n```bash\npython -m build\n```\n\nInstall the wheel package; this will install the extension.\n\n```bash\npip install ./dist/etc_jupyterlab_cell_properties-*-py3-none-any.whl\n```\n\nStart Jupyter Lab.\n\n```bash\njupyter lab\n```\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall etc_jupyterlab_cell_properties\n```\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\n## Usage\n\n\n\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\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# Change directory to the etc_jupyterlab_cell_properties directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable etc_jupyterlab_cell_properties\n# Rebuild extension Typescript source after making changes\njlpm run build\n```\n\nYou 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 extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\n# Server extension must be manually disabled in develop mode\njupyter server extension disable etc_jupyterlab_cell_properties\npip uninstall etc_jupyterlab_cell_properties\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `@educational-technology-collective/etc_jupyterlab_cell_properties` within that folder.\n","readmeFilename":"README.md"}