Metadata-Version: 2.1
Name: rimu
Version: 11.4.1
Summary: Rimu is a readable-text to HTML markup language inspired by AsciiDoc and Markdown.
Home-page: https://github.com/srackham/rimu-py
Author: Stuart Rackham
Author-email: srackham@gmail.com
License: MIT
Project-URL: Documentation, https://srackham.github.io/rimu/
Project-URL: Source, https://github.com/srackham/rimu-py
Keywords: rimu markdown asciidoc
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

A port of the [Rimu Markup language](https://srackham.github.io/rimu/) written
in the Python language.


## Features
Functionally identical to the [TypeScript
implementation](https://github.com/srackham/rimu) version 11.4.0.


## Usage
Install from [PyPI](https://pypi.org/project/rimu/) using the Python `pip` command:

    pip install rimu

Example usage:

``` python
import rimu

print(rimu.render('*Hello World*!'))
```

See also Rimu
[API documentation](https://srackham.github.io/rimu/reference.html#api).


## CLI command
The [Rimu CLI
command](https://srackham.github.io/rimu/reference.html#rimuc-command) installed
by Pip is named `rimupy`. CLI command example:

``` sh
echo 'Hello *Rimu*!' | rimupy
```

This will output:

``` html
<p>Hello <em>Rimu</em>!</p>
```


## Building
Development is carried out in a Conda virtual environment so you need to have either Anaconda or Miniconda installed.

Build instructions:

1. Install the source repo from Github:

        git clone https://github.com/srackham/rimu-py.git

2. Create the `rimu-py` Conda environment (this includes Python and all the necessary Python packages):

        cd rimu-py/
        conda env create --file rimu-py-env.yaml

3. Run tests and build rimu-py:

        conda activate rimu-py
        make build


## Learn more
Read the [documentation](https://srackham.github.io/rimu/reference.html) and experiment
with Rimu in the [Rimu
Playground](http://srackham.github.io/rimu/rimuplayground.html).


## Implementation
- The largely one-to-one correspondence between the canonical
  [TypeScript code](https://github.com/srackham/rimu) 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.
