https://github.com/osscar-org/widget-code-input
A jupyter widget to allow input of a python function, with syntax highlighting
https://github.com/osscar-org/widget-code-input
jupyter jupyter-labextension jupyter-widget jupyter-widgets jupyterlab widget
Last synced: 3 months ago
JSON representation
A jupyter widget to allow input of a python function, with syntax highlighting
- Host: GitHub
- URL: https://github.com/osscar-org/widget-code-input
- Owner: osscar-org
- License: other
- Created: 2019-05-06T11:02:44.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T10:59:00.000Z (4 months ago)
- Last Synced: 2025-03-26T23:22:07.028Z (4 months ago)
- Topics: jupyter, jupyter-labextension, jupyter-widget, jupyter-widgets, jupyterlab, widget
- Language: JavaScript
- Homepage:
- Size: 1.09 MB
- Stars: 8
- Watchers: 1
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# widget-code-input
[](https://badge.fury.io/py/widget-code-input)
[](https://mybinder.org/v2/gh/osscar-org/widget-code-input/main?labpath=%2Fexamples%2FWidget_Demo.ipynb)
[](https://github.com/osscar-org/widget-code-input/actions/workflows/widget-test.yml)
[](https://github.com/osscar-org/widget-code-input/actions/workflows/screenshot-comparison.yml)
A widget to allow input of a python function, with syntax highlighting.
## Installation
You can install using `pip`:
```bash
pip install widget_code_input
```
### Releasing and publishing a new version
In order to make a new release of the library and publish to PYPI, run
```bash
bumpver update --major/--minor/--patch
```
This will
- update version numbers, make a corresponding `git commit` and a `git tag`;
- push this commit and tag to Github, which triggers the Github Action that makes a new Github Release and publishes the package to PYPI.
### Github workflow testing
[](https://github.com/osscar-org/widget-code-input/actions/workflows/widget-test.yml)
If the `widget test` fails, it indicates there is something wrong with the code, and the widget is NOT
being displayed correctly in the test.
[](https://github.com/osscar-org/widget-code-input/actions/workflows/screenshot-comparison.yml)
If the `widget test` passes but the `screenshot comparison` fails, it indicates the appearance of the widget
is different from the previous version. In this case, you'll need to manually download the artifact from
the `widget test` and use it to replace the `widget-sample.png` figure in the `test` folder.
## Acknowledgements
We acknowledge support from the EPFL Open Science Fund via the [OSSCAR](http://www.osscar.org) project.
