#########
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 <https://raesl.ratio-case.nl>`_ for more info
on how to use RaESL.
***************
Developer guide
***************
Python packaging information
============================
This project is packaged using `poetry <https://python-poetry.org/>`_. Packaging
information as well as dependencies are stored in `pyproject.toml <./pyproject.toml>`_.
Installing the project and its development dependencies can be done using ``poetry install -E all``.
Versioning
==========
This project uses `semantic versioning <https://semver.org>`_. Version increments are
checked using `Raver <https://raver.ratio-case.nl>`_.
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 <./pyproject.toml>`_ for both Black and Ruff.
Raw data
{
"_id": null,
"home_page": "https://raesl.ratio-case.nl",
"name": "raesl",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Ratio Innovations B.V.",
"author_email": "info@ratio-case.nl",
"download_url": "https://files.pythonhosted.org/packages/72/45/d1e6da20177ec48fd8d1fcc2f39ffc8f1bd3870219b46054df0450ffe5d2/raesl-0.14.1.tar.gz",
"platform": null,
"description": "#########\nRatio ESL\n#########\n\nRatio support for the Elephant Specification Language (ESL) in Python.\n\n\n**********\nQuickstart\n**********\n\nInstallation\n============\n\nRaESL can be installed using ``pip install raesl[all]`` for any Python version >=3.9. Or,\nfor Poetry managed projects, use ``poetry add raesl -E all`` to add it as a dependency.\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\n\nThe default ``compile`` command is always available.\n\nPlease refer to the `usage documentation <https://raesl.ratio-case.nl>`_ for more info\non how to use RaESL.\n\n***************\nDeveloper guide\n***************\n\nPython packaging information\n============================\n\nThis project is packaged using `poetry <https://python-poetry.org/>`_. Packaging\ninformation as well as dependencies are stored in `pyproject.toml <./pyproject.toml>`_.\n\nInstalling the project and its development dependencies can be done using ``poetry install -E all``.\n\nVersioning\n==========\n\nThis project uses `semantic versioning <https://semver.org>`_. Version increments are\nchecked using `Raver <https://raver.ratio-case.nl>`_.\n\nChangelog\n=========\n\nChangelog format as described by https://keepachangelog.com/ has been adopted and can be reviewed\n`on this page <https://raesl.ratio-case.nl/changelog.html>`.\n\nTests\n=====\n\nTests can be run using ``poetry run pytest``.\n\nLinting\n=======\n\nLinting config is included in `pyproject.toml <./pyproject.toml>`_ for both Black and Ruff.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Ratio ESL support in Python.",
"version": "0.14.1",
"project_urls": {
"Documentation": "https://raesl.ratio-case.nl",
"Homepage": "https://raesl.ratio-case.nl",
"Repository": "https://gitlab.com/ratio-case-os/python/raesl"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f38f65e634fa0d2a197b0c72c834782905dce746c65a2714e99bf7b1781fa8e",
"md5": "8100ff940b930385100f8f08a10bf046",
"sha256": "f258409945f13df4bc2067aee3c4e861c70e8c9d3e39ab4d339b2a77065a4bea"
},
"downloads": -1,
"filename": "raesl-0.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8100ff940b930385100f8f08a10bf046",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 225455,
"upload_time": "2024-02-08T14:51:00",
"upload_time_iso_8601": "2024-02-08T14:51:00.440144Z",
"url": "https://files.pythonhosted.org/packages/8f/38/f65e634fa0d2a197b0c72c834782905dce746c65a2714e99bf7b1781fa8e/raesl-0.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7245d1e6da20177ec48fd8d1fcc2f39ffc8f1bd3870219b46054df0450ffe5d2",
"md5": "41d2644bd00fd4fa403d4a5394623518",
"sha256": "f519c916007c3f35d9ef509ab17715db7e929b2ce68a5a6eb028484dc84836e1"
},
"downloads": -1,
"filename": "raesl-0.14.1.tar.gz",
"has_sig": false,
"md5_digest": "41d2644bd00fd4fa403d4a5394623518",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 172171,
"upload_time": "2024-02-08T14:51:01",
"upload_time_iso_8601": "2024-02-08T14:51:01.934027Z",
"url": "https://files.pythonhosted.org/packages/72/45/d1e6da20177ec48fd8d1fcc2f39ffc8f1bd3870219b46054df0450ffe5d2/raesl-0.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 14:51:01",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ratio-case-os",
"gitlab_project": "python",
"lcname": "raesl"
}
JSON