semvec/pypi-packages huggingface dataset:
boringmd 1.2.0
Extract plain text and front matter from Markdown documents
License: MIT
Requires Python: ~=3.9
Keywords: markdown, text

# boringmd

`boringmd` is a Python package and command line tool for extracting plain text and front matter from Markdown.

## Installation

`boringmd` requires Python 3.9 or later.

```bash
pip install boringmd
```

## Command line

Pass the filename of a Markdown document to extract its plain text content:

```bash
boringmd input.md
```

To extract the front matter only, include the `--front-matter` flag:

```bash
boringmd input.md --front-matter
```

`boringmd` prints to stdout. To write the extraction to a file, redirect it:

```bash
boringmd input.md > output.txt
```

## Package

```python
from boringmd import front_matter_from_string, text_from_string
markdown = "---\nfoo: bar\n---\n**foo** and _bar_"
print(text_from_string(markdown))
# foo and bar
print(front_matter_from_string(markdown))
# foo: bar

from pathlib import Path
from boringmd import front_matter_from_file, text_from_file
print(text_from_file(Path("input.md")))
print(front_matter_from_file(Path("input.md")))
```

## Related packages

`boringmd` uses [cariad/lstr](https://github.com/cariad/lstr) to manipulate strings.