frontmatter
A simple Python package for parsing YAML Frontmatter from a text file or string. Written for Python 3, but should also work for Python 2.7.
Usage
from frontmatter import Frontmatter
# assuming 'testfile.md' exists
post = Frontmatter.read_file('testfile.md')
print(post['attributes'], "\n") # Dictionary
print(post['body'], "\n") # String
print(post['frontmatter']) # String
The output would be:
{'foo': 'bar', 'num': 3, 'list': ['first', 'second', 'third']}
This is the actual post content
This is a second line
foo: bar
num: 3
list:
- first
- second
- third
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
Copyright (c) 2018, Jonathan Beebe
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1 maintainer
Release files for frontmatter 3.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| frontmatter-3.0.8.tar.gz | 5.3 kB | Details |
Release files / frontmatter-3.0.8.tar.gz
| Download URL | frontmatter-3.0.8.tar.gz |
|---|---|
| Size | 5.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d913619d20f607e03557d52a8bf9b249e0b3093c770c5213c0f1231d2c97fe73
|
|
BLAKE2b-256 checksum How to use checksums |
8bde7425e1c97db39ca6615ccf89d8c3b47f2ee8dfdabb754fc99f925ee1a702
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
