This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
IPyTangle
=========

|build-badge| |pypi-badge|

Reactive narratives inspired by
`Tangle <http: worrydream.com="" tangle=""/>`__ in the `Jupyter
Notebook <http: jupyter.org="">`__.

IPyTangle makes plain markdown into an interactive part of your
data-driven narrative.

.. |build-badge| image:: https://travis-ci.org/bollwyvl/ipytangle.svg
:target: https://travis-ci.org/bollwyvl/ipytangle
.. |pypi-badge| image:: https://img.shields.io/pypi/v/ipytangle.svg
:target: https://pypi.python.org/pypi/ipytangle/

.. figure:: screenshots/cookies/002_change.png
:alt:

Installation
------------

Get the most recent release with:

.. code:: bash

pip install ipytangle

Or the bleeding-edge version:

.. code:: bash

pip install -e git+https://github.com/bollwyvl/ipytangle#egg=IPyTangle

Usage
-----

In a Notebook, write this python...

.. code:: python

from ipytangle import tangle

tangle(cookies=3, calories=lambda cookies: cookies * 50)

And this markdown:

.. code:: markdown

When you eat [`cookies` cookies](#:cookies), you consume [`calories` calories](#:calories).

And you would see something like this:

When you eat ```2`` cookies <#:cookies>`__, you consume ```150``
calories <#:>`__.

And interacting with the links would cause the result to update.

Examples
--------

Adapted from the originals from
`Tangle <http: worrydream.com="" tangle=""/>`__.

- `Cookies <notebooks examples="" cookies.ipynb="">`__
- `California State Parks Proposition
21 <notebooks examples="" proposition%2021.ipynb="">`__

Additionally, ``ipytangle`` comes with integration with IPython's
``interact``, the easiest way to start using widgets.

- ```Interact``\ ing with a
tangle <notebooks examples="" interacting%20with%20a%20tangle.ipynb="">`__
- `Tangling up
``interact`` <notebooks examples="" tangling%20up%20interact.ipynb="">`__

Markdown
--------

``ipytangle`` implements most of the
`TangleKit <https: github.com="" worrydream="" tangle="" blob="" master="" tanglekit="" tanglekit.js="">`__
baseline as markdown links. Because it adds no new notation, unrendered
Tangle Markdown should still render in a useful way.

Generally, think of a link as:

.. code:: markdown

[what the user sees](#:tangle types)

In the link text, backticks, **\`\`** are used to represent a JavaScript
expression that will be updated on user interaction, cascading updates,
or other updates from the kernel. In addition to any variables defined
with ``ipytangle``, some `formatting <#Formatting>`__ libraries are
provided. ``window`` globals should also work :wink:.

Only the generated ``code`` blocks will be transformed, the rest of the
elements (if any) will be preserved. This means you can use images,
inside the label of a control, for example.

Link Types
~~~~~~~~~~

``[<stringy expression="">](#:)``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

just display a view

.. code:: markdown

For [`years` years](#:) have I trained Jedi.

``[<stringy expression="">](#:<variable>)``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

display a view and update an integer based on dragging

.. code:: markdown

[made the kessel run in `distance` parsecs](#:distance)

``[<booly expression="">](#:if)`` ... *[\_ ``[<booly expression="">](#elif)``\ \_]* ... *[\_ ``[](#:else)`` \_]* ... ``[](#:endif)``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

mark some text (which may have other fields) to only display based on
condition

.. code:: markdown

What's more foolish? The [`fool_is_more_foolish`](#:if)fool[](#:else)the fool who follows him(#:endif).

you may also have an ``else`` and any number of ``elif``\ s... because
they are markdown span-level elements, you may use newlines for easier
editing

.. code:: markdown

[`feeling == "bad"`](#:if) I have a bad feeling about this.
[`feeling == "cautious"`](#:elif) You will never find a more wretched hive of scum and villainy.
[](#:else) Search your feelings.
[](#:endif)

Proposed Link Types
~~~~~~~~~~~~~~~~~~~

``[<stringy expression="">](#:<variable>:(int|float):<min>:<max>:<step>)``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

display a view and update some ``type`` of variable. Additionally,
``min``\ imum ``max``\ imum and ``step``-size values can be specified.

``[](#:<variable>:inline)``
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Replace the ``variable``, for which a linked widget has been registered
(TBD) with the widget itself inline. > Needs research.

Widgets
~~~~~~~

At it's core, ``ipytangle`` provides ``Tangle``, an IPython ``Widget``.
Because of this, a ``Tangle`` can connect to any other IPython widgets
via *traitlets* and ``links``. Unlike many widgets, a ``Tangle`` doesn't
do much with its screen real estate, and might not be very interesting
to put inside a layout. Yet.

There are several methods for creating a ``Tangle``.

``ipytangle.tangle``
^^^^^^^^^^^^^^^^^^^^

As in the above example, this tries to be the most pythonic approach.

.. code:: python

from ipytangle import tangle

square = tangle(x=1, y=(1, lambda x: x*x))

print("square is", square)
square.x = 2
print("y is", square.y)


.. parsed-literal::

square is <ipython.utils.traitlets.dynamicautotangle139717235746760 object="" at="" 0x7f1274347ef0="">
y is 4


Linking to other widgets
''''''''''''''''''''''''

``tangle`` makes working with other core and custom widgets easy,
automatically copying trait information. If a widget implements
``value``, as most of the core widgets do, you can reference it
directly. Alternately, specify a ``tuple`` of ``(widget, "trait_name")``
to subscribe to that trait.

.. code:: python

from IPython.html.widgets import IntSlider

x = IntSlider(1)
square = tangle(x=x, y=(1, lambda x: x*x))

print("square is", square)
x.value = 2
print("y is", square.y)


.. parsed-literal::

square is <ipython.utils.traitlets.dynamicautotangle139717235839048 object="" at="" 0x7f1274362080="">
y is 4


``ipytangle.Tangle``
^^^^^^^^^^^^^^^^^^^^

If you are already familiar with widgets, subclassing ``Tangle`` might
be the most convenient:

.. code:: python

from ipytangle import Tangle
from IPython.utils import traitlets

class Square(Tangle):
x = traitlets.CInt(1, sync=True)
y = traitlets.CInt(1, sync=True)

def _x_changed(self):
self.y = self.x * self.x

square = Square()

print("square is", square)
square.x = 2
print("y is", square.y)


.. parsed-literal::

square is <__main__.Square object at 0x7f127434b7f0>
y is 4


*A future version of IPython Widgets will allow dynamically-added
traits with ``add_trait``. This will open up whole new areas for
tinkering. Stay tuned!*

Formatting
~~~~~~~~~~

In addition to your locally-bound variables, ``ipytangle`` bundles
several nice JavaScript libraries and shortcuts for formatting text and
numbers: - ```moment`` <http: momentjs.com=""/>`__ dates and times -
```mathjs`` <http: mathjs.org=""/>`__ scientific
units\ ``- [``\ numeral\`](http://numeraljs.com/) currency, and
miscellany

Inspiration
-----------

Of course, Brett Victor's `Tangle <http: worrydream.com="" tangle=""/>`__ is
the primary inspiration, as well as: -
`tributary <http: tributary.io=""/>`__ - `derby <http: derbjys.org="">`__ -
`d3 <http: d3js.org="">`__

Roadmap
-------

- support
`TangleKit <https: github.com="" worrydream="" tangle="" blob="" master="" tanglekit="" tanglekit.js="">`__
baseline
- float
- switch
- :math:`L_AT^EX` (sic)
- sparklines, distributions, etc.
- offline/nbviewer?
Release History

Release History

0.4.0

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.3.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.2.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.4

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
ipytangle-0.4.0.tar.gz (520.7 kB) Copy SHA256 Checksum SHA256 Source Jun 10, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting