Ratio ESL#
Ratio support for the Elephant Specification Language (ESL) in Python.
Quickstart#
Installation#
RaESL can be installed using pip install raesl[all] for any Python version >=3.9. Or,
for Poetry managed projects, use poetry add raesl -E all to add it as a dependency.
For RaESL’s different subcommands and functionality, the wheel provides extras which you could
provide instead of the all used above:
doc: documentation generation using pandoc, Markdown and optionally LaTeX.jupyter: a Jupyter ESL kernel.pygments: an ESL syntax highlighter for pygments.rich: Rich doc output in the form of Plotly images.server: A language server to parse documents.
The default compile command is always available.
Please refer to the usage documentation for more info on how to use RaESL.
Developer guide#
Python packaging information#
This project is packaged using poetry. Packaging information as well as dependencies are stored in pyproject.toml.
Installing the project and its development dependencies can be done using poetry install -E all.
Versioning#
This project uses semantic versioning. Version increments are checked using Raver.
Changelog#
Changelog format as described by https://keepachangelog.com/ has been adopted and can be reviewed on this page <https://raesl.ratio-case.nl/changelog.html>.
Tests#
Tests can be run using poetry run pytest.
Linting#
Linting config is included in pyproject.toml for both Black and Ruff.