Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 4 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 (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-07-13T13:39:30.000Z (7 months ago)
Last Synced: 2024-09-30T10:48:44.340Z (5 months ago)
Topics: jupyter, jupyter-labextension, jupyter-widget, jupyter-widgets, jupyterlab, widget
Language: Python
Homepage:
Size: 1.07 MB
Stars: 7
Watchers: 2
Forks: 5
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# widget-code-input

[![PyPI version](https://badge.fury.io/py/widget-code-input.svg)](https://badge.fury.io/py/widget-code-input)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/osscar-org/widget-code-input/main?labpath=%2Fexamples%2FWidget_Demo.ipynb)
[![widget test](https://github.com/osscar-org/widget-code-input/actions/workflows/widget-test.yml/badge.svg)](https://github.com/osscar-org/widget-code-input/actions/workflows/widget-test.yml)
[![screenshot comparison](https://github.com/osscar-org/widget-code-input/actions/workflows/screenshot-comparison.yml/badge.svg)](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

[![widget test](https://github.com/osscar-org/widget-code-input/actions/workflows/widget-test.yml/badge.svg)](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.

[![screenshot comparison](https://github.com/osscar-org/widget-code-input/actions/workflows/screenshot-comparison.yml/badge.svg)](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.