https://github.com/paddymul/ts-ipywidget-starter

The simplest widget-ts repository that I could create that builds in typescript and is succesfully pip installable
https://github.com/paddymul/ts-ipywidget-starter

Last synced: 9 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/paddymul/ts-ipywidget-starter
• Owner: paddymul
• License: bsd-3-clause
• Created: 2023-04-09T17:11:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-28T11:42:35.000Z (about 1 year ago)
• Last Synced: 2024-10-29T05:05:27.627Z (about 2 months ago)
• Language: TypeScript
• Size: 3.02 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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](https://github.com/bloomberg/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

```bash

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

https://github.com/jupyterlab/hatch-jupyter-builder/issues/112

https://github.com/jupyter-widgets/widget-ts-cookiecutter/issues/131

https://github.com/jupyter-widgets/widget-ts-cookiecutter/issues/133

https://github.com/jupyter-widgets/ipywidgets/issues/3755

https://github.com/jupyterlab/hatch-jupyter-builder/issues/113