Skip to content

A jupyter widget to allow input of a python function, with syntax highlighting

License

Notifications You must be signed in to change notification settings

osscar-org/widget-code-input

Repository files navigation

widget-code-input

PyPI version Binder widget test screenshot comparison

A widget to allow input of a python function, with syntax highlighting.

Installation

You can install using pip:

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

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

widget test

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.

screenshot comparison

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 project.