2
2
jupyter-ui-poll
3
3
===============
4
4
5
- .. image :: https://mybinder.org/badge_logo.svg
6
- :target: `run it`_
5
+ |Documentation Status | |Binder |
7
6
8
7
Block Jupyter cell execution while interacting with widgets.
9
8
@@ -59,7 +58,7 @@ Quick, self contained example:
59
58
# Wait for user to press the button
60
59
with ui_events() as poll:
61
60
while ui_done is False :
62
- poll(10 ) # React to UI events (upto 10 at a time)
61
+ poll(10 ) # React to UI events (up to 10 at a time)
63
62
print (' .' , end = ' ' )
64
63
time.sleep(0.1 )
65
64
print (' done' )
@@ -76,7 +75,7 @@ This library requires Python 3.6 or greater.
76
75
77
76
pip install jupyter-ui-poll
78
77
# or with conda/mamba
79
- conda install -c kirill-odc jupyter-ui-poll
78
+ conda install -c conda-forge jupyter-ui-poll
80
79
81
80
82
81
Technical Details
@@ -87,7 +86,7 @@ interactive data investigation apps directly inside Jupyter notebook or Jupyter
87
86
lab environment. Jupyter is great at displaying data and ``ipywidgets `` provide
88
87
a mechanism to get input from the user in a more convenient way than entering or
89
88
changing Python code inside a Jupyter cell. Developer can construct an
90
- interactive user interface often used to parameterise information display or
89
+ interactive user interface often used to parameterize information display or
91
90
other kinds of computation.
92
91
93
92
Interactivity is handled with callbacks, ``ipywidget `` GUI is HTML based, user
@@ -147,3 +146,10 @@ Basic idea was copied from ``ipython_blocking`` [#]_ project:
147
146
.. _Example notebook : notebooks/Examples.ipynb
148
147
.. _run it : https://mybinder.org/v2/gh/kirill888/jupyter-ui-poll/develop?filepath=notebooks%2FExamples.ipynb
149
148
.. _Binder : https://mybinder.org/
149
+
150
+ .. |Documentation Status | image :: https://readthedocs.org/projects/jupyter-ui-poll/badge/?version=latest
151
+ :target: https://jupyter-ui-poll.readthedocs.io/en/latest/?badge=latest
152
+
153
+ .. |Binder | image :: https://mybinder.org/badge_logo.svg
154
+ :target: https://mybinder.org/v2/gh/kirill888/jupyter-ui-poll/develop?filepath=notebooks%2FExamples.ipynb
155
+ :alt: Run Examples in Binder
0 commit comments