wxyz

Experimental [Widgets][] for [JupyterLab][].

| build | demo | docs | | :-----------------------: | :-------------------------: | :--------------------------------------------------------: | | [![build-badge][]][build] | [![binder-badge][]][binder] | [DOCS][] — [EXAMPLES][] — [CHANGELOG][] — [CONTRIBUTING][] |

Install and Use

| pip or conda install W | from wxyz.Y | import Z | powered by | | :----------------------- | -----------------: | :----------------------------------------------------------------------------------------- | ------------------------------------------ | | wxyz_core | core | JSON
UnJSON
| jsonpointer
jsonschema | | wxyzdatagrid | datagrid | DataGrid
GridStyle
SelectGrid
StyleGrid | pandas
wxyzcore | | wxyzhtml | html | AlphaColorPicker
File
FileBox
FullScreen
JSONFile
TextFile | wxyzcore | | wxyzdvcs | dvcs | repos.repogit.Git
Watcher | gitpython
watchgod
wxyz_core | | wxyzjsone | jsone | JSONE | jsone
wxyzcore | | wxyzjsonschemaform | jsonschemaform | JSONSchemaForm | wxyzcore | | wxyzjsonld | jsonld | Compact
Expand
Flatten
Frame
Normalize | pyld
wxyzcore | | wxyzlab | lab | DockBox
DockPop
Editor
Markdown
Terminal
ModeInfo | jupyterlab
wxyzcore | | wxyzsvg | svg | SVGBox | wxyzcore | | wxyztpljinja | tpljinja | Template | jinja2
wxyzcore | | wxyzyaml | yaml | YAML | pyyaml
wxyzcore |

Strongly Discouraged

wxyznotebooks, not recommended for production use, requires all of the wxyz* packages.

Some extra(s) dangerous dependencies are available as well

pip install wxyznotebooks              # wxyz*
pip install wxyz_notebooks[binder]      # everything used on binder demos, used in tests
pip install wxyz_notebooks[thirdparty]  # some casually co-tested third-party packages
pip install wxyz_notebooks[all]         # everything. it's a lot. good luck.

It is unknown whether the heavier dependencies will continue to work in the future and may carry very specific version pins which might not be solveable with any old:

• operating system
• version of python
• package manager

Motivation

wxyz contains a number of "missing pieces" from the [ipywidgets][] toolbox. It is made up of a number of packages for Python and the browser, in [this repo][]. While many create pixels on the page, some are focused around configurably transforming the [traitlets][] of one widget to another, in the kernel, the browser or both.

Uninstall

We're sad to see you go!

Use pip or conda to uninstall any wxyz_* packages.

Alternatives

If you don't like wxyz, that's fine! There are a number of related tools that might be better suited to your needs.

• [formulas]

- a python-side re-implementation of an Excel/LibreOffice reactive functional programming model

• [ipyevents]

- fine-grained DOM event control

• [ipylab]

- a number of similar utilities as parts of wxyz.lab, and nice support for commands, and additional [lumino][] primitives, e.g. SplitPanel

• [ipyregulartable]

- a high-performance datagrid solution, supporting pandas MultiIndex-type data

• [jupyter-starters]

- wizard-style project templates, driven by simple configuration, JSON Schema or notebooks

• [jupyterlab-tour]

- a pleasant "guided tour" of JupyterLab via CSS selectors and JSON Schema

Code of Conduct

wxyz contributors and users are expected to behave in a manner in line with the [code of conduct].

Open Source

wxyz is licensed under the [BSD-3-Clause][license]

[binder-badge]: https://mybinder.org/badge_logo.svg [binder]: https://mybinder.org/v2/gh/deathbeds/wxyz/main?urlpath=lab/tree/src/py/wxyz_notebooks/src/wxyz/notebooks/index.ipynb [docs]: https://deathbeds.github.io/wxyz [build-badge]: https://dev.azure.com/nickbollweg/deathbeds/_apis/build/status/deathbeds.wxyz?branchName=main [build]: https://dev.azure.com/nickbollweg/deathbeds/_build/latest?definitionId=6&branchName=main [changelog]: https://github.com/deathbeds/wxyz/blob/main/CHANGELOG.md [contributing]: https://github.com/deathbeds/wxyz/blob/main/CONTRIBUTING.md [examples]: https://github.com/deathbeds/wxyz/blob/main/src/py/wxyz_notebooks/src/wxyz/notebooks/index.ipynb [formulas]: https://pypi.org/project/formulas/ [ipyevents]: https://github.com/mwcraig/ipyevents [ipylab]: https://github.com/jtpio/ipylab [ipyregulartable]: https://github.com/jpmorganchase/ipyregulartable [ipywidgets]: https://github.com/jupyter-widgets/ipywidgets [jupyter-starters]: https://pypi.org/project/jupyter-starters/ [jupyterlab-tour]: https://github.com/fcollonval/jupyterlab-tour [jupyterlab]: https://github.com/jupyterlab/jupyterlab [lumino]: https://github.com/jupyterlab/lumino [this repo]: https://github.com/deathbeds/wxyz [traitlets]: https://github.com/ipython/traitlets [widgets]: https://jupyter.org/widgets [license]: https://github.com/deathbeds/wxyz/blob/main/CHANGELOG.md [code of conduct]: https://github.com/deathbeds/wxyz/blob/main/CODEOFCONDUCT.md