..
Copyright 2021-2023 Boris Shminke
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|PyPI version|\ |CircleCI|\ |Documentation Status|\ |codecov|
yapsap
======
``yapsap`` is Yet Another Python SAturation-style Prover. Currently,
it can only prove theorems in `TPTP library <https://tptp.org>`__
formal language in `clausal normal form
<https://en.wikipedia.org/wiki/Conjunctive_normal_form>`__.
``yapsap`` implements the `given clause algorithm
<https://royalsocietypublishing.org/doi/10.1098/rsta.2018.0034#d3e468>`__
and was inspired by `PyRes <https://github.com/eprover/PyRes>`__.
How to Install
==============
The best way to install this package is to use ``pip``:
.. code:: sh
pip install git+https://github.com/inpefess/yapsap.git
How to use
==========
.. code:: python
from random import choice, seed
from yapsap import YapsaProver
class RandomProver(YapsaProver):
def proof_attempt(self) -> None:
while not self.proof_found:
self._step(choice(list(self.state.keys())))
prover = RandomProver(
"./yapsap/resources/TPTP-mock/Problems/TST/TST001-1.p"
)
seed(0)
prover.proof_attempt()
print(prover.state)
How to Contribute
=================
`Pull requests <https://github.com/inpefess/yapsap/pulls>`__ are
welcome. To start:
.. code:: sh
git clone https://github.com/inpefess/yapsap
cd yapsap
# activate python virtual environment with Python 3.8+
pip install -U pip
pip install -U setuptools wheel poetry
poetry install
# recommended but not necessary
pre-commit install
To check the code quality before creating a pull request, one might
run the script ``local-build.sh``. It locally does nearly the same as
the CI pipeline after the PR is created.
Reporting issues or problems with the software
==============================================
Questions and bug reports are welcome on `the
tracker <https://github.com/inpefess/yapsap/issues>`__.
More documentation
==================
More documentation can be found
`here <https://yapsap.readthedocs.io/en/latest>`__.
.. |PyPI version| image:: https://badge.fury.io/py/yapsap.svg
:target: https://badge.fury.io/py/yapsap
.. |CircleCI| image:: https://circleci.com/gh/inpefess/yapsap.svg?style=svg
:target: https://circleci.com/gh/inpefess/yapsap
.. |Documentation Status| image:: https://readthedocs.org/projects/yapsap/badge/?version=latest
:target: https://yapsap.readthedocs.io/en/latest/?badge=latest
.. |codecov| image:: https://codecov.io/gh/inpefess/yapsap/branch/master/graph/badge.svg
:target: https://codecov.io/gh/inpefess/yapsap
Raw data
{
"_id": null,
"home_page": "https://github.com/inpefess/yapsap",
"name": "yapsap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<3.12",
"maintainer_email": "",
"keywords": "saturation-style proving,automated theorem proving,given clause algorithm",
"author": "Boris Shminke",
"author_email": "boris@shminke.com",
"download_url": "https://files.pythonhosted.org/packages/32/5b/ac05ace0b0512db2b7cda048ad1c270f6c7a464cdc86cfa0b95bc1c80dac/yapsap-0.0.2.tar.gz",
"platform": null,
"description": "..\n Copyright 2021-2023 Boris Shminke\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n https://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n\n|PyPI version|\\ |CircleCI|\\ |Documentation Status|\\ |codecov|\n\nyapsap\n======\n\n``yapsap`` is Yet Another Python SAturation-style Prover. Currently,\nit can only prove theorems in `TPTP library <https://tptp.org>`__\nformal language in `clausal normal form\n<https://en.wikipedia.org/wiki/Conjunctive_normal_form>`__.\n``yapsap`` implements the `given clause algorithm\n<https://royalsocietypublishing.org/doi/10.1098/rsta.2018.0034#d3e468>`__\nand was inspired by `PyRes <https://github.com/eprover/PyRes>`__.\n\nHow to Install\n==============\n\nThe best way to install this package is to use ``pip``:\n\n.. code:: sh\n\n pip install git+https://github.com/inpefess/yapsap.git\n\nHow to use\n==========\n\n.. code:: python\n\n from random import choice, seed\n\n from yapsap import YapsaProver\n\n\n class RandomProver(YapsaProver):\n def proof_attempt(self) -> None:\n while not self.proof_found:\n self._step(choice(list(self.state.keys())))\n\n\n prover = RandomProver(\n \"./yapsap/resources/TPTP-mock/Problems/TST/TST001-1.p\"\n )\n seed(0)\n prover.proof_attempt()\n print(prover.state)\n\nHow to Contribute\n=================\n\n`Pull requests <https://github.com/inpefess/yapsap/pulls>`__ are\nwelcome. To start:\n\n.. code:: sh\n\n git clone https://github.com/inpefess/yapsap\n cd yapsap\n # activate python virtual environment with Python 3.8+\n pip install -U pip\n pip install -U setuptools wheel poetry\n poetry install\n # recommended but not necessary\n pre-commit install\n \nTo check the code quality before creating a pull request, one might\nrun the script ``local-build.sh``. It locally does nearly the same as\nthe CI pipeline after the PR is created.\n\nReporting issues or problems with the software\n==============================================\n\nQuestions and bug reports are welcome on `the\ntracker <https://github.com/inpefess/yapsap/issues>`__.\n\nMore documentation\n==================\n\nMore documentation can be found\n`here <https://yapsap.readthedocs.io/en/latest>`__.\n\n.. |PyPI version| image:: https://badge.fury.io/py/yapsap.svg\n :target: https://badge.fury.io/py/yapsap\n.. |CircleCI| image:: https://circleci.com/gh/inpefess/yapsap.svg?style=svg\n :target: https://circleci.com/gh/inpefess/yapsap\n.. |Documentation Status| image:: https://readthedocs.org/projects/yapsap/badge/?version=latest\n :target: https://yapsap.readthedocs.io/en/latest/?badge=latest\n.. |codecov| image:: https://codecov.io/gh/inpefess/yapsap/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/inpefess/yapsap\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Yet Another Python SAturation Prover",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/inpefess/yapsap",
"Repository": "https://github.com/inpefess/yapsap"
},
"split_keywords": [
"saturation-style proving",
"automated theorem proving",
"given clause algorithm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69739301e0b37e2e56355f07411e18344c1549fbfcc10fef40572bd573db1634",
"md5": "28c27ec8db7a5aa11b5cdfd975c1d674",
"sha256": "6f5df208d96dd3f087ddca62a9cb1d310fad21240243afe34291f060ba9e0eeb"
},
"downloads": -1,
"filename": "yapsap-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28c27ec8db7a5aa11b5cdfd975c1d674",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<3.12",
"size": 24082,
"upload_time": "2023-10-07T17:19:29",
"upload_time_iso_8601": "2023-10-07T17:19:29.645341Z",
"url": "https://files.pythonhosted.org/packages/69/73/9301e0b37e2e56355f07411e18344c1549fbfcc10fef40572bd573db1634/yapsap-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "325bac05ace0b0512db2b7cda048ad1c270f6c7a464cdc86cfa0b95bc1c80dac",
"md5": "7cf9974fd99974c9b04d584c519642f1",
"sha256": "7d1e42ec9a8d7af1b02329e48f012168b639682fcc92cc0708f13d6f875294b3"
},
"downloads": -1,
"filename": "yapsap-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "7cf9974fd99974c9b04d584c519642f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<3.12",
"size": 17323,
"upload_time": "2023-10-07T17:19:32",
"upload_time_iso_8601": "2023-10-07T17:19:32.720807Z",
"url": "https://files.pythonhosted.org/packages/32/5b/ac05ace0b0512db2b7cda048ad1c270f6c7a464cdc86cfa0b95bc1c80dac/yapsap-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-07 17:19:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "inpefess",
"github_project": "yapsap",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "yapsap"
}
JSON
