Skip to main content

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.11. For managed projects you can use:

  • uv: uv add raesl[all]
  • Poetry: poetry add raesl -E all

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 raesl compile command is always available.

Please refer to the usage documentation for more info on how to use RaESL.

Development installation

This project is packaged using uv as the environment manager and build frontend. Packaging information as well as dependencies are stored in pyproject.toml.

For ease of use, this project uses the just command runner to simplify common tasks. Installing the project and its development dependencies can be done by running just install in the cloned repository directory or manually by running uv sync --all-extras.

Please consult the justfile for the underlying commands or run just to display a list of all available commands.

Tests

Tests can be run using just test and subsequent arguments will be passed to pytest.

Linting

Linting the project can be done using just lint, automatic fixes can be applied using just fix. Linting config is included in pyproject.toml for Ruff.

Documentation

Documentation can be built using just docs or served continuously using just serve-docs with the help of Material for MkDocs.

Contributions and license

To get contributing, feel free to fork, pick up an issue or file your own and get going for your first merge! We'll be more than happy to help.

For contribution instructions, head over to CONTRIBUTING.md.

RaPlan is licensed following a dual licensing model. In short, we want to provide anyone that wishes to use our published software under the GNU GPLv3 to do so freely and without any further limitation. The GNU GPLv3 is a strong copyleft license that promotes the distribution of free, open-source software. In that spirit, it requires dependent pieces of software to follow the same route. This might be too restrictive for some. To accommodate users with specific requirements regarding licenses, we offer a proprietary license. The terms can be discussed by reaching out to Ratio.

Metadata

Release files for raesl 0.19.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for raesl 0.19.0
File Size Uploaded Provenance Actions
raesl-0.19.0.tar.gz 207.7 kB Without provenance Details for raesl-0.19.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for raesl 0.19.0
File Interpreter ABI Platform Actions
raesl-0.19.0-py3-none-any.whl Python 3 none any Details for raesl-0.19.0-py3-none-any.whl

Total release size: 471.3 kB

Release files / raesl-0.19.0.tar.gz

Download URL raesl-0.19.0.tar.gz
Size 207.7 kB
Tags Source
SHA-256 checksum
How to use checksums
7016bcbf2bf095e2955f8f3627f312921a43672e9905be0eeac07fa53b49a9f7
BLAKE2b-256 checksum
How to use checksums
c61673f9cb9e5423821a9e7daa3b4cbd12ba41668ad27b0cec624310ade0141e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / raesl-0.19.0-py3-none-any.whl

Download URL raesl-0.19.0-py3-none-any.whl
Size 263.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5b4550ffe4e0fd01d2291165ca1153539a969816e9684c10577b4e02a2bf1d2e
BLAKE2b-256 checksum
How to use checksums
bd524799afa57d4280f6a0df3490ea945d91a344a552ecec176ad20591fce334
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.15.2

Security for raesl 0.19.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.19.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page