Skip to main content

Simple reusable magics.

Project description

``magical-magic``
=================

Dead simple ``IPython`` magics.

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

``pip install magical-magic``

Basic Usage
-----------

.. code:: python

import magical
env = magical.register_jinja2_magic() # returns a jinja environment
magical.register_mistune_magic(escape=False)
magical.register_yaml_magic()



.. parsed-literal::

<IPython.core.display.Javascript object>



.. parsed-literal::

<IPython.core.display.Javascript object>



.. parsed-literal::

<IPython.core.display.Javascript object>


.. code:: python

data = {'🐮': 'moo', '🐑': 'bah', '🔥': 'burn'}

.. code:: python

%%jinja2
# Jinja Cell Magics

`%%jinja2` inserts data from the notebook into the template.

## An example of a list

{% for key in data %}* {{key}} - __{{data[key]}}__
{% endfor %}



Jinja Cell Magics
=================

``%%jinja2`` inserts data from the notebook into the template.

An example of a list
--------------------

- 🐮 - **moo**
- 🔥 - **burn**
- 🐑 - **bah**


--------------

.. code:: python

%%mistune
## Mistune Cell Magics

`%%mistune` uses a pure Python markdown parser. For convenience, jinja templates can be used to
tell us about the length of `data` is {{data.__len__()}}.



.. raw:: html

<h2>Mistune Cell Magics</h2>
<p><code>%%mistune</code> uses a pure Python markdown parser. For convenience, jinja templates can be used to
tell us about the length of <code>data</code> is 3.</p>



--------------

Development
-----------

Running the Build and Tests
^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

pip install -r requirements-dev.txt
python setup.py develop
watchmedo tricks tricks.yaml

The ``watchmedo`` script will convert your notebooks to scripts and html
files. ``py.test-ipynb`` will test all notebooks matching
``test-*.ipynb``.

Running the docs
^^^^^^^^^^^^^^^^

::

jekyll serve docs -wit

Docs are hosted at ``http://localhost:4000/magical-magic/``.

License
-------

``magical-magic`` is released as free software under the `BSD 3-Clause
license <https://github.com/tonyfast/magical-magic/blob/master/LICENSE>`__.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

magical-magic-0.0.8.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

magical_magic-0.0.8-py3.5.egg (7.2 kB view details)

Uploaded Egg

File details

Details for the file magical-magic-0.0.8.tar.gz.

File metadata

  • Download URL: magical-magic-0.0.8.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for magical-magic-0.0.8.tar.gz
Algorithm Hash digest
SHA256 9e4f4683ac388626baef07ba0189765a79cd6805507ddf4ddf063f9309d4d296
MD5 9c15aefa9cb36654247f21c22e91b7dd
BLAKE2b-256 9a6f307c90f184fb0f3439eec591f2a72cd45d86da1ffec79f3b7f442f90c7da

See more details on using hashes here.

File details

Details for the file magical_magic-0.0.8-py3.5.egg.

File metadata

File hashes

Hashes for magical_magic-0.0.8-py3.5.egg
Algorithm Hash digest
SHA256 758043f966d1a4a994b0c102a6bcdc4d0c7cb061a3c9c9448572009f2971a859
MD5 2512358c82b0a9a07047adce29c5761b
BLAKE2b-256 80c08036366e836a59732f8a5ebc2de95cf6aa36eb3636e1a74a349708deda1d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page