Skip to main content

a Jade ne Pug magic for IPython notebooks

Project description

an IPython magic for capturing data in YAML into a running IPython kernel.

Build Status pypi

Install

From the command line (or with ! in a notebook cell):

pip install yamlmagic

Enable

Ad-hoc

In the notebook, you can use the %load_ext or %reload_ext line magic.

%reload_ext yamlmagic

Configuration

In your profile’s ipython_kernel_config.py, you can add the following line to automatically load yamlmagic into all your running kernels:

c.InteractiveShellApp.extensions = ['yaml_magic']

Use

The %%yaml cell magic will either act as simple parser:

%%yaml
a_toplevel_key: 1
<IPython.core.display.Javascript object>
{'a_toplevel_key': 1}

which can be accessed by the special last result variable _:

_
{'a_toplevel_key': 1}

Or will update a named variable with the parsed document:

%%yaml x
- a: 1
  b: 2
<IPython.core.display.Javascript object>
x
[{'a': 1, 'b': 2}]

By default, yaml.SafeLoader will be used, which won’t allow the powerful but dangerous (and unportable) `!python/ tags <http://pyyaml.org/wiki/PyYAMLDocumentation#YAMLtagsandPythontypes>`__. If you’d like to use them, provide the -l (or --loader) argument with a BaseLoader subclass available via a local variable…

from yaml import Loader
class FooLoader(Loader):
    # some special things you have built
    pass
%%yaml --loader FooLoader
!!python/float 0
<IPython.core.display.Javascript object>
0.0

…or dotted-notation path to a loader:

%%yaml --loader yaml.Loader
!!python/float 0
<IPython.core.display.Javascript object>
0.0

Contribute

Issues and pull requests welcome!

License

yamlmagic is released as free software under the BSD 3-Clause license.

Thank

Project details


Release history Release notifications

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
jademagic-0.1.0-py2.py3-none-any.whl (5.5 kB) Copy SHA256 hash SHA256 Wheel 3.5 Feb 13, 2016
jademagic-0.1.0.tar.gz (6.0 kB) Copy SHA256 hash SHA256 Source None Feb 13, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page