Tools for reading yaml headers from markdown files
Project description
YAML Header Tools
A python package to manage yaml header in markdown document
YAML-Headers for markdown documents are described in: https://pandoc.org/MANUAL.html#extension-yaml_metadata_block
They are used by many systems to include metadata in markdown documents.
This python package can be installed using pip
, e.g.:
pip install --user .
Usage
The following example loads a yaml header from a markdown file.
from yaml_header_tools import *
header = get_header_from_file("testfile.md")
Running the tests
After installation of the package run (within the project folder):
pytest
Contributers
The original authors of this package are:
- Alexander Schlemmer
- Daniel Hornung
- Timm Fitschen
License
Copyright (C) 2019-2022 Research Group Biomedical Physics, Max Planck Institute for Dynamics and Self-Organization Göttingen.
All files in this repository are licensed under a GNU Affero General Public License (version 3 or later).
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
Built Distribution
Hashes for yaml_header_tools-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f9b3563a4e1b526a53a146dabe331156563c55130472500ebeb4da7b732a673 |
|
MD5 | bdadafcbcbec576db6cb847c33274b1e |
|
BLAKE2b-256 | 70e6d6859b0b4b095ce257e5a3338f23399573a29b06946407dbecb12ddd1f3c |