paddymul / ts-ipywidget-starter

The simplest widget-ts repository that I could create that builds in typescript and is succesfully pip installable

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ts-ipywidget-starter

This is the most barebones repo that I could cobble tobgether that does the following

  1. Builds an ipywidget
  2. Uses typescript code in that widget
  3. is pip installable
  4. Allows a widgert to use react

This is built by stripping as much possible from Bloomberg's ipydatagrid

There are some remaining dependency on the term ipydatagrid in this repo.

I want to expose a minimally useable repo so other people can create ipywidgets too. This minimal repo is also a good way for jupyterlab contributors to diagnose the packaging problems I have been having.

If you choose to use this repo to start building your own ipywidgets, understand that this isn't for serious final packaging, it's an intermediate step to keep you moving with your development.

This package has the following limitations:

  1. you can only install one widget based on this repo or ipydatagrid. There will be conflicts otherwise
  2. I don't know how it works and can't help you understand how the build process works.

How to Build

python -m pip install --upgrade twine
python -m pip install --upgrade twine
rm -rf node_modules
rm -rf dist
python -m build .
rm dist/index.js dist/index.js.LICENSE.txt
twine check dist/*
python -m twine upload --repository testpypi dist/*

Related github issues

jupyterlab/hatch-jupyter-builder#112 jupyter-widgets/widget-ts-cookiecutter#131 jupyter-widgets/widget-ts-cookiecutter#133

jupyter-widgets/ipywidgets#3755 jupyterlab/hatch-jupyter-builder#113

About

The simplest widget-ts repository that I could create that builds in typescript and is succesfully pip installable

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:TypeScript 75.4%Language:Python 17.3%Language:JavaScript 6.3%Language:CSS 0.8%Language:HTML 0.1%