py-frontmatter 0.5.0a6

Manipulate YAML front matter.

py-frontmatter

To manipulate front matter in document file.

Installation

pip install py-frontmatter

Usage

Given text file:

---
title: Hacker's note
tags: [a, b]
---
# header
text

Get or set whole section of front matter

To retrieve front matter as JSON:

% frontmatter get note.md | jq
{
  "title": "Hacker's note",
  "tags": [
    "a",
    "b"
  ]
}

To replace the front matter:

% echo '{"title": "My note", "tags": ["a", "b", "c"]}' | frontmatter set note.md
% cat note.md
---
title: My note
tags:
- a
- b
- c
---
# header
text

Add or remove item from front matter

% frontmatter add-item --jsonpath '$.tags' --item d note.md
% cat note.md
---
title: My note
tags:
- a
- b
- c
- d
---
# header
text
%
% frontmatter remove-item --jsonpath '$.tags' --item d note.md
% cat note.md
---
title: My note
tags:
- a
- b
- c
---
# header
text

Specialize commands to add/remove tag

% frontmatter add-tag --tag d note.md
% cat note.md
---
title: My note
tags:
- a
- b
- c
- d
---
# header
text
% frontmatter remove-tag --tag d note.md
% cat note.md
---
title: My note
tags:
- a
- b
- c
---
# header
text

License

py-frontmatter is distributed under the terms of the following licenses:

• Apache-2.0