Parse and manage posts with YAML frontmatter
Project description
[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.# this works, too >>> print(post) 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:
>>> sorted(post.keys()) ['layout', 'title']>>> from pprint import pprint >>> post['excerpt'] = 'tl;dr' >>> pprint(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 io 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file python-frontmatter-0.2.1.tar.gz
.
File metadata
- Download URL: python-frontmatter-0.2.1.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
dd0cec2723fd974841226bd2d03e140224fe3b8f1ef48f1b42ee282939587eeb
|
|
MD5 |
7bedf612865302db33c92c3abc9a8520
|
|
BLAKE2b-256 |
8e4a0e3c1514ac22956c5b665b9aeda0d646129df21e4ca63e6c532ff86ae8a6
|