python-frontmatter 0.1.2

Parse and manage posts with YAML frontmatter

[Jekyll](http://jekyllrb.com/)-style YAML front matter offers a useful way to add arbitrary, structured metadata to text documents, regardless of type.

This is a small package to load and parse files (or just text) with YAML front matter.

[](https://travis-ci.org/eyeseast/python-frontmatter)

Usage:

>>> import frontmatter

Load a post from a filename:

>>> post = frontmatter.load('tests/hello-world.markdown')

Or a file (or file-like object):

>>> with open('tests/hello-world.markdown') as f:
...     post = frontmatter.load(f)

Or load from text:

>>> with open('tests/hello-world.markdown') as f:
...     post = frontmatter.loads(f.read())

Access content:

>>> print post.content
Well, hello there, world.

Use metadata (metadata gets proxied as post keys):

>>> print post['title']
Hello, world!

Metadata is a dictionary, with some handy proxies:

>>> post.keys()
['layout', 'title']

>>> post['excerpt'] = 'tl;dr'
>>> post.metadata
{'excerpt': 'tl;dr', 'layout': 'post', 'title': 'Hello, world!'}

If you don’t need the whole post object, just parse:

>>> with open('tests/hello-world.markdown') as f:
...     metadata, content = frontmatter.parse(f.read())
>>> print metadata['title']
Hello, world!

Write back to plain text, too:

>>> print frontmatter.dumps(post) # doctest: +NORMALIZE_WHITESPACE
---
excerpt: tl;dr
layout: post
title: Hello, world!
---
Well, hello there, world.

Or write to a file (or file-like object):

>>> from cStringIO import StringIO
>>> f = StringIO()
>>> frontmatter.dump(post, f)
>>> print f.getvalue() # doctest: +NORMALIZE_WHITESPACE
---
excerpt: tl;dr
layout: post
title: Hello, world!
---
Well, hello there, world.