| Name | JPSL-Tools-Menu JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | JLab compatible convenience menu for common activities in Jupyter Physical Science Lab. |
| upload_time | 2024-07-09 16:28:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Jonathan Gutow 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. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JPSL_Tools_Menu
<!-- Not yet functional
[](https://github.com/JupyterPhysSciLab/JPSL_Tools_Menu/actions/workflows/build.yml)
-->
JLab compatible convenience menu for common activities in Jupyter Physical Science Lab.
Current menu items:
* "__Hide before print__" hides cells selected for hiding using
[jupyter-instructortools
](https://github.com/JupyterPhysSciLab/jupyter-instructortools).
* "__Undo hide before print__" reveals the hidden cells.
* "__Algebra with Sympy__" submenu:
* "__Insert Algebra with Sympy initialization code__" inserts in place of
the current selection the properly formed import statement to initialize
the Algebra_with_Sympy package.
* "__Algebra with Sympy Docs__" opens a new browser window showing the
documentation.
* "__JupyterPiDaQ__" submenu:
* "__Insert JupyterPiDAQ initialization code__" inserts in place of the
current selection the properly formed import statement to initialize the
JupyterPiDAQ live data acquisition package.
* "__JupyterPiDAQ Docs__" opens the documentation in a new browser window.
* "__Pandas GUI__" submenu:
* "__Insert PandasGUI initialization code__" inserts in place of the
current selection the properly formed import statement to initialize the
PandasGUI package of graphical tools to help generate code to manipulate
and display data stored in [Pandas](https://pandas.pydata.org/) DataFrames.
* "__Insert load data from CSV code__" replaces the current selection with
the skeleton code for loading data from a CSV file into a Pandas DataFrame.
* "__Insert New Calculated Column GUI__" replaces the current selection
with a
function call that opens the graphical user interface to assist in
generating code to create a new calculated column in a Pandas DataFrame.
* "__Insert New Plot GUI__" replaces the current selection with a function
call that opens the graphical user interface to generate code for making
a [Plotly](https://plotly.com/python/) plot from data in a Pandas DataFrame.
* "__Insert New Fit GUI__" replaces the current selection with a function
call
that opens the graphical user interface to generate code for fitting
data using the [lmfit](https://lmfit.github.io/lmfit-py/) package and
plotting the results using Plotly.
* "__PandasGUI Docs__" opens the documentation in a new browser window.
## Requirements
- JupyterLab >= 4.0.0
- algebra_with_sympy >= 1.0.0
- jupyterpidaq >= 0.8.1
- jupyter-pandas-gui >= 0.9.0
## Install
To install the extension, execute:
```bash
pip install JPSL_Tools_Menu
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall JPSL_Tools_Menu
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the JPSL_Tools_Menu directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build
```
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 extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
```
With 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).
By default, the `jlpm 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:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
pip uninstall JPSL_Tools_Menu
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `JPSL_Tools_Menu` within that folder.
### Testing the extension (not complete yet)
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "JPSL-Tools-Menu",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Jonathan Gutow <gutow@uwosh.edu>",
"download_url": "https://files.pythonhosted.org/packages/1f/69/679c90e21ef4a119aa0cfeba17c4fff1634c27e0d535b31f4dcd2f8e8417/jpsl_tools_menu-0.2.0.tar.gz",
"platform": null,
"description": "# JPSL_Tools_Menu\n<!-- Not yet functional\n[](https://github.com/JupyterPhysSciLab/JPSL_Tools_Menu/actions/workflows/build.yml)\n-->\nJLab compatible convenience menu for common activities in Jupyter Physical Science Lab.\n\nCurrent menu items:\n* \"__Hide before print__\" hides cells selected for hiding using \n [jupyter-instructortools\n ](https://github.com/JupyterPhysSciLab/jupyter-instructortools).\n* \"__Undo hide before print__\" reveals the hidden cells.\n* \"__Algebra with Sympy__\" submenu:\n * \"__Insert Algebra with Sympy initialization code__\" inserts in place of \n the current selection the properly formed import statement to initialize \n the Algebra_with_Sympy package.\n * \"__Algebra with Sympy Docs__\" opens a new browser window showing the \n documentation.\n* \"__JupyterPiDaQ__\" submenu:\n * \"__Insert JupyterPiDAQ initialization code__\" inserts in place of the \n current selection the properly formed import statement to initialize the \n JupyterPiDAQ live data acquisition package.\n * \"__JupyterPiDAQ Docs__\" opens the documentation in a new browser window.\n* \"__Pandas GUI__\" submenu:\n * \"__Insert PandasGUI initialization code__\" inserts in place of the \n current selection the properly formed import statement to initialize the \n PandasGUI package of graphical tools to help generate code to manipulate \n and display data stored in [Pandas](https://pandas.pydata.org/) DataFrames.\n * \"__Insert load data from CSV code__\" replaces the current selection with \n the skeleton code for loading data from a CSV file into a Pandas DataFrame.\n * \"__Insert New Calculated Column GUI__\" replaces the current selection \n with a \n function call that opens the graphical user interface to assist in \n generating code to create a new calculated column in a Pandas DataFrame.\n * \"__Insert New Plot GUI__\" replaces the current selection with a function \n call that opens the graphical user interface to generate code for making \n a [Plotly](https://plotly.com/python/) plot from data in a Pandas DataFrame.\n * \"__Insert New Fit GUI__\" replaces the current selection with a function \n call \n that opens the graphical user interface to generate code for fitting \n data using the [lmfit](https://lmfit.github.io/lmfit-py/) package and \n plotting the results using Plotly.\n * \"__PandasGUI Docs__\" opens the documentation in a new browser window.\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n- algebra_with_sympy >= 1.0.0\n- jupyterpidaq >= 0.8.1\n- jupyter-pandas-gui >= 0.9.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install JPSL_Tools_Menu\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall JPSL_Tools_Menu\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 JPSL_Tools_Menu 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# Rebuild extension Typescript source after making changes\njlpm 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 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 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\npip uninstall JPSL_Tools_Menu\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 `JPSL_Tools_Menu` within that folder.\n\n### Testing the extension (not complete yet)\n\n#### Frontend tests\n\nThis extension is using [Jest](https://jestjs.io/) for JavaScript code testing.\n\nTo execute them, execute:\n\n```sh\njlpm\njlpm test\n```\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Jonathan Gutow 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.",
"summary": "JLab compatible convenience menu for common activities in Jupyter Physical Science Lab.",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/JupyterPhysSciLab/JPSL_Tools_Menu/issues",
"Homepage": "https://github.com/JupyterPhysSciLab/JPSL_Tools_Menu",
"Repository": "https://github.com/JupyterPhysSciLab/JPSL_Tools_Menu.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "352150976828923ad9526fa36f1f012a611b4a81c809da5850d9407e45ab4956",
"md5": "1b5f82cc621123068fd432de01eacad3",
"sha256": "8ddd80c55646e8b5ba13317194ae8978ed7f52b5124dfd54df3ff735c6b4bd36"
},
"downloads": -1,
"filename": "jpsl_tools_menu-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b5f82cc621123068fd432de01eacad3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17577,
"upload_time": "2024-07-09T16:28:06",
"upload_time_iso_8601": "2024-07-09T16:28:06.408892Z",
"url": "https://files.pythonhosted.org/packages/35/21/50976828923ad9526fa36f1f012a611b4a81c809da5850d9407e45ab4956/jpsl_tools_menu-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f69679c90e21ef4a119aa0cfeba17c4fff1634c27e0d535b31f4dcd2f8e8417",
"md5": "82e861236b9edf7ffdbb14a788497af2",
"sha256": "53b538059eaed7512425fdad2a83c45f611b594d41d586e0906a3c0b5038de5d"
},
"downloads": -1,
"filename": "jpsl_tools_menu-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "82e861236b9edf7ffdbb14a788497af2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 148621,
"upload_time": "2024-07-09T16:28:08",
"upload_time_iso_8601": "2024-07-09T16:28:08.800483Z",
"url": "https://files.pythonhosted.org/packages/1f/69/679c90e21ef4a119aa0cfeba17c4fff1634c27e0d535b31f4dcd2f8e8417/jpsl_tools_menu-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 16:28:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JupyterPhysSciLab",
"github_project": "JPSL_Tools_Menu",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jpsl-tools-menu"
}
