Skip to main content

YAML Front Matter parser

Project description

A very simple Python package for parsing YAML Front Matter from a text file. Written for Python 3, but works for 2.

Usage

import frontmatter

# assuming 'testfile.md' exists
post = frontmatter.parse('testfile.md')

print(post['metadata']) # Dictionary
print(post['content'])  # String

The output would be:

{'foo': 'bar', 'num': 3, 'list': ['first', 'second', 'third']}

This is the actual post content
This is a second line

In the above example, the contents of testfile.md is:

---
foo: bar
num: 3
list:
- first
- second
- third
---

This is the actual post content
This is a second line

LICENSE

This package is licensed under ISC.

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

frontmatter-1.0.0.tar.gz (4.6 kB view hashes)

Uploaded Source

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