.. image:: docs/machetli.svg
:width: 20 %
:align: right
:alt:
Machetli
========
**Machetli** is a Python package for reproducing characteristics of a program
(such as bugs) with modified instances. It is meant to be helpful for debugging
complex programs and narrowing down where specific behaviors are caused.
Currently, Machetli handles instances for automated planners, specified either
in PDDL or in the SAS\ :sup:`+` format used by `Fast Downward
<https://www.fast-downward.org>`__ but adding support for other file formats is
easy.
Installation
------------
Machetli requires Python 3.7+ and can be installed with ``pip``.
.. code-block:: bash
pip install machetli
If you want to avoid changes to your system-wide Python installation you can
`install Machetli in a virtual Python environment
<https://machetli.readthedocs.io/en/latest/installation.html>`_.
Usage
-----
An `interactive demo of Machetli <https://tinyurl.com/machetli-demo>`_ is
available as a Jupyter notebook on Google Colab. You can find additional
examples in the directory `examples
<https://github.com/aibasel/machetli/tree/main/examples>`_.
For a more detailed description, please refer to the `documentation
<https://machetli.readthedocs.io/en/latest/usage.html>`_.
Support
-------
* Documentation: https://machetli.readthedocs.io
* Issue tracker: https://github.com/aibasel/machetli/issues
* Code: https://github.com/aibasel/machetli
License
-------
Machetli is licensed under GPL3. We use code from `Fast Downward
<https://github.com/aibasel/downward>`__ and `Lab <https://github
.com/aibasel/lab>`_ under GPL3.
Raw data
{
"_id": null,
"home_page": "https://github.com/aibasel/machetli",
"name": "machetli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Lucas Galery K\u00e4ser",
"author_email": "lucas.galerykaeser@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/8d/1f80fe94f97582ae28c4d8691e289ddb6622eae7792c990d83e62bfe8b7e/machetli-0.9.tar.gz",
"platform": null,
"description": ".. image:: docs/machetli.svg\n :width: 20 %\n :align: right\n :alt: \n \nMachetli\n========\n\n**Machetli** is a Python package for reproducing characteristics of a program\n(such as bugs) with modified instances. It is meant to be helpful for debugging\ncomplex programs and narrowing down where specific behaviors are caused.\n\nCurrently, Machetli handles instances for automated planners, specified either\nin PDDL or in the SAS\\ :sup:`+` format used by `Fast Downward\n<https://www.fast-downward.org>`__ but adding support for other file formats is\neasy.\n\n\nInstallation\n------------\n\nMachetli requires Python 3.7+ and can be installed with ``pip``.\n\n.. code-block:: bash\n\n pip install machetli\n\nIf you want to avoid changes to your system-wide Python installation you can\n`install Machetli in a virtual Python environment\n<https://machetli.readthedocs.io/en/latest/installation.html>`_.\n\n\nUsage\n-----\n\nAn `interactive demo of Machetli <https://tinyurl.com/machetli-demo>`_ is\navailable as a Jupyter notebook on Google Colab. You can find additional\nexamples in the directory `examples\n<https://github.com/aibasel/machetli/tree/main/examples>`_.\n\nFor a more detailed description, please refer to the `documentation\n<https://machetli.readthedocs.io/en/latest/usage.html>`_.\n\n\nSupport\n-------\n\n* Documentation: https://machetli.readthedocs.io\n* Issue tracker: https://github.com/aibasel/machetli/issues\n* Code: https://github.com/aibasel/machetli\n\n\nLicense\n-------\n\nMachetli is licensed under GPL3. We use code from `Fast Downward\n<https://github.com/aibasel/downward>`__ and `Lab <https://github\n.com/aibasel/lab>`_ under GPL3.\n",
"bugtrack_url": null,
"license": "GPL3+",
"summary": "Locate bugs in your program",
"version": "0.9",
"project_urls": {
"Documentation": "https://machetli.readthedocs.io/",
"Homepage": "https://github.com/aibasel/machetli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56bfea88bd08bd543d4900fabca66ab36c4be6692da9583b6578939491563ceb",
"md5": "d6679560e3d95d0556531bb93eeabd43",
"sha256": "3db00929e32e41bd5431bbabafccc07c4fccf74aca7efd1ca9fc7897171d6f56"
},
"downloads": -1,
"filename": "machetli-0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6679560e3d95d0556531bb93eeabd43",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 70970,
"upload_time": "2024-09-05T09:10:20",
"upload_time_iso_8601": "2024-09-05T09:10:20.036867Z",
"url": "https://files.pythonhosted.org/packages/56/bf/ea88bd08bd543d4900fabca66ab36c4be6692da9583b6578939491563ceb/machetli-0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da8d1f80fe94f97582ae28c4d8691e289ddb6622eae7792c990d83e62bfe8b7e",
"md5": "f29a909d39e7c15b649934b92d79b01c",
"sha256": "1dd318bc40c055e9694238bde53a79ee8ccc60293bdd2099c7dc1edd591d890f"
},
"downloads": -1,
"filename": "machetli-0.9.tar.gz",
"has_sig": false,
"md5_digest": "f29a909d39e7c15b649934b92d79b01c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 61260,
"upload_time": "2024-09-05T09:10:22",
"upload_time_iso_8601": "2024-09-05T09:10:22.008199Z",
"url": "https://files.pythonhosted.org/packages/da/8d/1f80fe94f97582ae28c4d8691e289ddb6622eae7792c990d83e62bfe8b7e/machetli-0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-05 09:10:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aibasel",
"github_project": "machetli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "machetli"
}
JSON
