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


Download files

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

Source Distribution

jademagic-0.1.0.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

jademagic-0.1.0-py2.py3-none-any.whl (5.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file jademagic-0.1.0.tar.gz.

File metadata

  • Download URL: jademagic-0.1.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for jademagic-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b7cd647e83fd7ad45620f26b806d24c85af86216c0c540a3cdff38786971ce9f
MD5 6697eb9ac28797541739e99ade0b15ca
BLAKE2b-256 7343eb7178727a2caca097f0a552b77538ff4caf0c46504ca8d41a698c13f053

See more details on using hashes here.

File details

Details for the file jademagic-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for jademagic-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e0728b23201011d777aa091eb9df4ccb6b2e8dc9ce3c3b38181022f2dfbd834e
MD5 ea17cefa70123ae3722b27ed08f63b25
BLAKE2b-256 474ff94cf542eeaba7ee2e9eaf1babd52bf3041f442f3782ec1b9ebdd7220d16

See more details on using hashes here.

Supported by

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