0.5.1 • Published 3 years ago

@deathbeds/wxyz-json-e v0.5.1

Weekly downloads
6
License
BSD-3-Clause
Repository
github
Last release
3 years ago

@deathbeds/wxyz-json-e

pypi-badge npm-badge [docs-badge]

experimental Jupyter widgets for JSON-E

If you just want to use @deathbeds/wxyz-json-e in JupyterLab 3

pip install wxyz_json_e  # or conda, or mamba

Developer Installation

The public API of the widgets in @deathbeds/wxyz-json-e are not yet fully documented. However, it's likely that you can:

jlpm add @deathbeds/wxyz-json-e

and then, in your widget extension:

import wxyz from '@deathbeds/wxyz-json-e';

console.log(wxyz); // and see _something_

Legacy Installation (Pre-JupyterLab 2)

This approach is no longer recommended, and is not tested

Prerequisites:

  • python >=3.7
  • nodejs >=12
  • jupyterlab >=3,<4
jupyter labextension install @jupyter-widgets/jupyterlab-manager @deathbeds/wxyz-core @deathbeds/wxyz-json-e
pip install wxyz_json_e

wxyz

Experimental Widgets for JupyterLab.

builddemodocs
build-badgebinder-badgeDOCSEXAMPLESCHANGELOGCONTRIBUTING

Install and Use

pip or conda install Wfrom wxyz.Yimport Zpowered by
wxyz_corecoreJSONUnJSONjsonpointerjsonschema
wxyz_datagriddatagridDataGridGridStyleSelectGridStyleGridpandaswxyz_core
wxyz_htmlhtmlAlphaColorPickerFileFileBoxFullScreenJSONFileTextFilewxyz_core
wxyz_dvcsdvcsrepos.repo_git.GitWatchergitpythonwatchgodwxyz_core
wxyz_json_ejson_eJSONEjsonewxyz_core
wxyz_json_schema_formjson_schema_formJSONSchemaFormwxyz_core
wxyz_jsonldjsonldCompactExpandFlattenFrameNormalizepyldwxyz_core
wxyz_lablabDockBoxDockPopEditorMarkdownTerminalModeInfojupyterlabwxyz_core
wxyz_svgsvgSVGBoxwxyz_core
wxyz_tpl_jinjatpl_jinjaTemplatejinja2wxyz_core
wxyz_yamlyamlYAMLpyyamlwxyz_core

Strongly Discouraged

wxyz_notebooks, not recommended for production use, requires all of the wxyz_* packages.

Some extra(s) dangerous dependencies are available as well

pip install wxyz_notebooks              # 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