Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bootstrap structure for a widget examples repo #13

Merged
merged 22 commits into from
Mar 22, 2021

Conversation

jtpio
Copy link
Contributor

@jtpio jtpio commented Mar 15, 2021

First step towards a "Widget Examples" repository for ipywidgets: jupyter-widgets/ipywidgets#3136

Heavily inspired by the JupyterLab Extension Examples: https://github.com/jupyterlab/extension-examples

The idea is to set up the basic structure for multiple custom widget examples in the same repo, so that we have the tools and CI in place to iterate and easily add new examples.

TODO

@jtpio
Copy link
Contributor Author

jtpio commented Mar 15, 2021

Example CI run in the fork: jtpio#1

@jtpio
Copy link
Contributor Author

jtpio commented Mar 16, 2021

Seeing some ESOCKETTIMEDOUT on macos-latest:

https://github.com/jtpio/custom-ipywidget-howto/pull/1/checks?check_run_id=2120510605

Maybe we can keep ubuntu-latest on CI for now and add back macos and windows later on.

@jtpio
Copy link
Contributor Author

jtpio commented Mar 16, 2021

Listing a couple of items to iterate on in follow-up PRs:

  • Enable tests on CI with pytest
  • Test on macos and windows on CI
  • Add the existing two examples jslink-custom-widgets and connecting-widgets to the list of examples

@jtpio
Copy link
Contributor Author

jtpio commented Mar 16, 2021

cc @ianhi if you want to have a look.

This PR is mostly about adding the tooling and the structure, more than actually working on the examples themselves.

Maybe there could be a couple more iterations before renaming the repo to widget-examples and moving it to the jupyter-widgets organization on GitHub.

@jtpio jtpio marked this pull request as ready for review March 16, 2021 14:18
@ianhi
Copy link
Owner

ianhi commented Mar 17, 2021

Hi @jtpio thanks so much for starting on this! I've been busy at the start of this week but will look at this tomorrow (today now?) evening.

@ianhi
Copy link
Owner

ianhi commented Mar 22, 2021

I had been playing a bit fast and loose with some of the formatting which prettier then mangled. So I updated that and removed some outdated portions of the readme.

@@ -9,14 +8,12 @@ Exploring how to give access of a widget's typescript model to a different widge

**Important questions:**

Q: Is this good practice? - A: I have no idea
Q: Is this good practice? - A: I have no idea
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jtpio do you know the answer to this?


## Structure

This example was bootstrapped from the [Jupyter TypeScript Cookiecutter](https://github.com/jupyter-widgets/widget-ts-cookiecutter) and follows the same structure.
Copy link
Owner

@ianhi ianhi Mar 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This example was bootstrapped from the [Jupyter TypeScript Cookiecutter](https://github.com/jupyter-widgets/widget-ts-cookiecutter) and follows the same structure.
This example was bootstrapped from the [Jupyter Widget TypeScript Cookiecutter](https://github.com/jupyter-widgets/widget-ts-cookiecutter) and follows the same structure.

Is that a more correct phrasing?

Copy link
Owner

@ianhi ianhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fantastic. Thanks so much for this. I have some follow up questions about how to best improve this but they can go into new issues.

@ianhi ianhi merged commit 326bb98 into ianhi:main Mar 22, 2021
@jtpio jtpio deleted the widget-examples branch March 23, 2021 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants