Metadata-Version: 2.4
Name: inscription
Version: 0.0.1
Summary: Parse machine-readable rules embedded in Markdown documents
Author-email: Mark Norman Francis <norm@201created.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# inscription

Parse out machine-readable rules embedded in Markdown documents. The rules are
still valid Markdown, so they can be easily read, edited, and understood by
humans.

```python
import inscription

markdown, rules = inscription.separate(text)
```

Rules are formatted as unordered lists, and must be the first things that
appears in the section.

```markdown
Normal Markdown appears alongside encoded rules.

# Valid rules

- Inventory _add_ Handaxe

Anything between the start of the section (or very start of file if it doesn't
begin with a header) are rules for computers.

# Invalid rules

- bananas
- raspberries

The rules must parse successfully, or they are treated as Markdown for humans.
```
