Rimu is a readable-text to HTML markup language inspired by AsciiDoc and Markdown.
A port of the Rimu Markup language written in the Python language.
Functionally identical to the TypeScript implementation version 11.4.0.
Install from PyPI using the Python
pip install rimu
import rimu print(rimu.render('*Hello World*!'))
See also Rimu API documentation.
The Rimu CLI
by Pip is named
rimupy. CLI command example:
echo 'Hello *Rimu*!' | rimupy
This will output:
Development is carried out in a Conda virtual environment so you need to have either Anaconda or Miniconda installed.
Install the source repo from Github:
git clone https://github.com/srackham/rimu-py.git
rimu-pyConda environment (this includes Python and all the necessary Python packages):
cd rimu-py/ conda env create --file environment.yaml
Run tests and build rimu-py:
conda activate rimu-py make build
Read the documentation and experiment with Rimu in the Rimu Playground.
The largely one-to-one correspondence between the canonical TypeScript code and the Python code eased porting and debugging. This will also make it easier to cross-port new features and bug-fixes.
All Rimu implementations share the same JSON driven test suites comprising over 300 compatibility checks.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.