Parse and manage posts with YAML (or other) frontmatter
Project description
Python Frontmatter
Jekyll-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 (or JSON, TOML or other) front matter.
Install:
pip install python-frontmatter
Usage:
>>> import frontmatter
Load a post from a filename:
>>> post = frontmatter.load('tests/yaml/hello-world.txt')
Or a file (or file-like object):
>>> with open('tests/yaml/hello-world.txt') as f: ... post = frontmatter.load(f)
Or load from text:
>>> with open('tests/yaml/hello-world.txt') 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/yaml/hello-world.txt') 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 BytesIO >>> f = BytesIO() >>> frontmatter.dump(post, f) >>> print(f.getvalue().decode('utf-8')) # doctest: +NORMALIZE_WHITESPACE --- excerpt: tl;dr layout: post title: Hello, world! --- Well, hello there, world.
For more examples, see files in the tests/
directory. Each sample file has a corresponding .result.json
file showing the expected parsed output. See also the examples/
directory, which covers more ways to customize input and output.
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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size python_frontmatter-1.0.0-py3-none-any.whl (9.0 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size python-frontmatter-1.0.0.tar.gz (15.1 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for python_frontmatter-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 766ae75f1b301ffc5fe3494339147e0fd80bc3deff3d7590a93991978b579b08 |
|
MD5 | 1693d470bc187243e568fdae26febab4 |
|
BLAKE2-256 | 5f0b95a67d6efbd26c3de5b05e267ed6dd6f359d761526b618e1395a057ae9fa |