ironvaultmd 0.1

Python-Markdown extension for parsing Iron Vault journals

iron-vault-mdparser

A Python-Markdown (github) extension to parse Markdown files from the Iron Vault (github) Obsidian plugin.

Mainly parses anything within ```iron-vault-mechanics ... ``` blocks, but als frontmatter YAML.

Setup

Dependencies to use the extension / run the sample parser are listed in requirements.txt. It's recommended to set up a virtual environment.

$ python -m venv venv
$ . ./venv/bin/activate
$ (venv) $ pip install -r requirements.txt

For dependencies needed for development, check the Development section below.

Usage

$ python ./ironvault.py /path/to/vault/Journals/Session.md /tmp/Session.html

Development

Dependencies

Dependencies are separated to those required to run the extension and sample parser, and those that are required for full development and CI pipeline runs (unit tests, coverage), and listed in requirements.in and requirements-dev.in respectively. Those are on high level only, and pip-tools is used to create a full list of requirements from it, which can then be passed pip install -f.

If you just want to hack some stuff together, the runtime dependencies are probably all you need, but if you want to e.g. add and run tests, go with the -dev ones. To make life easier, a set of precompiled requirements.txt and requirements-dev.txt files are added to the repository.

pip-tools

Dependencies are managed with pip-tools, which needs to be installed first, and latest now the virtual environment is very recommended.

$ python -m venv venv
$ . ./venv/bin/activate
(venv) $ pip install pip-tools

To compile and install runtime requirements:

(venv) $ pip-compile requirements.in -o requirements.txt
(venv) $ pip install -r requirements.txt

To compile and install both runtime and development requirements:

(venv) $ pip-compile requirements.in requirements-dev.in -o requirements-dev.txt
(venv) $ pip install -r requirements-dev.txt