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.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d8253cf5c0a7f52d4b64238c388ed39c0ae9c7de921a717782d312cb3e0547a |
|
MD5 | e07ae0e9d463c8b554ff5268fdd7f7e1 |
|
BLAKE2b-256 | b5d50cf4eda3ee23ad883144e75a4669655be103bd0ca54b4c452973ba9f9371 |