# 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](https://raesl.ratio-case.nl) for more info on how to use
RaESL.
## Development installation
This project is packaged using [uv](https://docs.astral.sh/uv/) as the environment manager and build
frontend. Packaging information as well as dependencies are stored in
[pyproject.toml](./pyproject.toml).
For ease of use, this project uses the [just](https://github.com/casey/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](./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](./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](https://squidfunk.github.io/mkdocs-material/).
## 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](./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.
Raw data
{
"_id": null,
"home_page": null,
"name": "raesl",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "engineering, language, management, requirements, specification, systems",
"author": null,
"author_email": "\"Ratio Innovations B.V.\" <info@ratio-case.nl>",
"download_url": "https://files.pythonhosted.org/packages/79/6a/efb6fa3d75878295f7d2861c4b7dda30b8d626b4e06cc0211376e2e6bfdd/raesl-0.14.4.tar.gz",
"platform": null,
"description": "# Ratio ESL\n\nRatio support for the Elephant Specification Language (ESL) in Python.\n\n## Quickstart\n\n### Installation\n\nRaESL can be installed using `pip install raesl[all]` for any Python version >=3.11.\nFor managed projects you can use:\n\n- uv: `uv add raesl[all]`\n- Poetry: `poetry add raesl -E all`\n\nFor RaESL's different subcommands and functionality, the wheel provides extras which you could\nprovide instead of the `all` used above:\n\n- `doc`: documentation generation using pandoc, Markdown and optionally LaTeX.\n- `jupyter`: a Jupyter ESL kernel.\n- `pygments`: an ESL syntax highlighter for pygments.\n- `rich`: Rich doc output in the form of Plotly images.\n- `server`: A language server to parse documents.\n\nThe default `raesl compile` command is always available.\n\nPlease refer to the [usage documentation](https://raesl.ratio-case.nl) for more info on how to use\nRaESL.\n\n## Development installation\n\nThis project is packaged using [uv](https://docs.astral.sh/uv/) as the environment manager and build\nfrontend. Packaging information as well as dependencies are stored in\n[pyproject.toml](./pyproject.toml).\n\nFor ease of use, this project uses the [just](https://github.com/casey/just) command runner to\nsimplify common tasks. Installing the project and its development dependencies can be done by\nrunning `just install` in the cloned repository directory or manually by running `uv sync --all-extras`.\n\nPlease consult the [justfile](./justfile) for the underlying commands or run `just` to display a\nlist of all available commands.\n\n### Tests\n\nTests can be run using `just test` and subsequent arguments will be passed to pytest.\n\n### Linting\n\nLinting the project can be done using `just lint`, automatic fixes can be applied using `just fix`.\nLinting config is included in [pyproject.toml](./pyproject.toml) for Ruff.\n\n### Documentation\n\nDocumentation can be built using `just docs` or served continuously using `just serve-docs` with\nthe help of [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).\n\n## Contributions and license\n\nTo get contributing, feel free to fork, pick up an issue or file your own and get going for your\nfirst merge! We'll be more than happy to help.\n\nFor contribution instructions, head over to [CONTRIBUTING.md](./CONTRIBUTING.md).\n\nRaPlan is licensed following a dual licensing model. In short, we want to provide anyone that\nwishes to use our published software under the GNU GPLv3 to do so freely and without any further\nlimitation. The GNU GPLv3 is a strong copyleft license that promotes the distribution of free,\nopen-source software. In that spirit, it requires dependent pieces of software to follow the same\nroute. This might be too restrictive for some. To accommodate users with specific requirements\nregarding licenses, we offer a proprietary license. The terms can be discussed by reaching out to\nRatio.\n",
"bugtrack_url": null,
"license": null,
"summary": "Ratio ESL support in Python.",
"version": "0.14.4",
"project_urls": {
"Bug Tracker": "https://gitlab.com/ratio-case-os/python/raesl/-/issues",
"Changelog": "https://raesl.ratio-case.nl/CHANGELOG/",
"Homepage": "https://raesl.ratio-case.nl",
"Repository": "https://gitlab.com/ratio-case-os/python/raesl"
},
"split_keywords": [
"engineering",
" language",
" management",
" requirements",
" specification",
" systems"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "99cdd40bc744c5a8f4ef2fe5aadafbc8b824b8aa0611b82b80e550c1ce7d4fe7",
"md5": "191c1a611acb972fc585796e9018770d",
"sha256": "25918317e4e104104e3c132c866be3c1033984e7a92ed19c1e475273ce3f3fdf"
},
"downloads": -1,
"filename": "raesl-0.14.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "191c1a611acb972fc585796e9018770d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 226645,
"upload_time": "2025-02-17T10:17:35",
"upload_time_iso_8601": "2025-02-17T10:17:35.808711Z",
"url": "https://files.pythonhosted.org/packages/99/cd/d40bc744c5a8f4ef2fe5aadafbc8b824b8aa0611b82b80e550c1ce7d4fe7/raesl-0.14.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "796aefb6fa3d75878295f7d2861c4b7dda30b8d626b4e06cc0211376e2e6bfdd",
"md5": "4c9a7808c250f73fb283bd6f781c7f3a",
"sha256": "f6c64892dce83c24390e6f394582853c97c0096974c4c418f59ab5088be57ebb"
},
"downloads": -1,
"filename": "raesl-0.14.4.tar.gz",
"has_sig": false,
"md5_digest": "4c9a7808c250f73fb283bd6f781c7f3a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 547850,
"upload_time": "2025-02-17T10:17:37",
"upload_time_iso_8601": "2025-02-17T10:17:37.256674Z",
"url": "https://files.pythonhosted.org/packages/79/6a/efb6fa3d75878295f7d2861c4b7dda30b8d626b4e06cc0211376e2e6bfdd/raesl-0.14.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-17 10:17:37",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ratio-case-os",
"gitlab_project": "python",
"lcname": "raesl"
}
JSON