tptp-lark-parser


Nametptp-lark-parser JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/inpefess/tptp-lark-parser
SummaryA TPTP parser using Lark
upload_time2023-02-08 17:32:55
maintainer
docs_urlNone
authorBoris Shminke
requires_python>=3.7.1,<3.12
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ..
  Copyright 2022-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.

|Binder|\ |PyPI version|\ |Anaconda|\ |CircleCI|\ |AppveyorCI|\ |Documentation Status|\ |codecov|\ |Zenodo|

tptp-lark-parser
================

.. attention::
   The project is inactive.

``tptp-lark-parser`` is a parser for the `TPTP library
<https://tptp.org>`__ language using the `Lark parser
<https://github.com/lark-parser/lark>`__. For now, only CNF
sublanguage is supported.

How to Install
==============

The best way to install this package is to use ``pip``:

.. code:: sh

   pip install tptp-lark-parser

The package is also available on ``conda-forge``:
   
.. code:: sh

   conda install -c conda-forge tptp-lark-parser
   
One can also run it in a Docker container:

.. code:: sh

   docker build -t tptp-lark-parser https://github.com/inpefess/tptp-lark-parser.git
   docker run -it --rm -p 8888:8888 tptp-lark-parser jupyter-lab --ip=0.0.0.0 --port=8888

How to Use
==========

.. code:: python

   from tptp_lark_parser import TPTPParser

   tptp_parser = TPTPParser()
   parsed_text = tptp_parser.parse("cnf(test, axiom, ~ p(Y, X) | q(X, Y)).")
   clause_literals = parsed_text[0].literals
   
See `the
notebook <https://github.com/inpefess/tptp-lark-parser/blob/master/notebooks/usage-example.ipynb>`__
or run it in
`Binder <https://mybinder.org/v2/gh/inpefess/tptp-lark-parser/HEAD?labpath=usage-example.ipynb>`__
for more information.

More Documentation
==================

More documentation can be found
`here <https://tptp-lark-parser.readthedocs.io/en/latest>`__.

Similar Projects
================

There are many TPTP parsers in different languages:

* `C <https://github.com/TPTPWorld/SyntaxBNF>`__ (by TPTP's creator Geoff Sutcliffe)
* `Java <https://github.com/marklemay/tptpParser>`__
* `C++ <https://github.com/leoprover/tptp-parser>`__
* `JavaScript <https://www.npmjs.com/package/tptp>`__
* `Rust <https://github.com/MichaelRawson/tptp>`__
* `Common Lisp <https://github.com/lisphacker/cl-tptp-parser>`__
* `Scala <https://github.com/leoprover/scala-tptp-parser>`__
* `Haskell <https://github.com/aztek/tptp>`__
* `OCaml <https://github.com/Gbury/dolmen>`__

There also is `another parser in Python <https://github.com/AndrzejKucik/tptp_python_parser>`__ containing only the Lark syntax file.

How to Cite
===========

If you want to cite the `tptp-lark-parser` in your research paper,
please use the following doi:
`<https://doi.org/10.5281/zenodo.7040540>`__.

How to Contribute
=================

Please read `the Code of Conduct
<https://tptp-lark-parser.readthedocs.io/en/latest/code-of-conduct.html>`__
and then follow `the contribution guide
<https://tptp-lark-parser.readthedocs.io/en/latest/contributing.html>`__.

.. |PyPI version| image:: https://badge.fury.io/py/tptp-lark-parser.svg
   :target: https://badge.fury.io/py/tptp-lark-parser
.. |CircleCI| image:: https://circleci.com/gh/inpefess/tptp-lark-parser.svg?style=svg
   :target: https://circleci.com/gh/inpefess/tptp-lark-parser
.. |Documentation Status| image:: https://readthedocs.org/projects/tptp-lark-parser/badge/?version=latest
   :target: https://tptp-lark-parser.readthedocs.io/en/latest/?badge=latest
.. |codecov| image:: https://codecov.io/gh/inpefess/tptp-lark-parser/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/inpefess/tptp-lark-parser
.. |Binder| image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/inpefess/tptp-lark-parser/HEAD?labpath=usage-example.ipynb
.. |AppveyorCI| image:: https://ci.appveyor.com/api/projects/status/7n0g3a3ag5hjtfi0?svg=true
   :target: https://ci.appveyor.com/project/inpefess/tptp-lark-parser
.. |Anaconda| image:: https://anaconda.org/conda-forge/tptp-lark-parser/badges/version.svg
   :target: https://anaconda.org/conda-forge/tptp-lark-parser
.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7040540.svg
   :target: https://doi.org/10.5281/zenodo.7040540

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/inpefess/tptp-lark-parser",
    "name": "tptp-lark-parser",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7.1,<3.12",
    "maintainer_email": "",
    "keywords": "",
    "author": "Boris Shminke",
    "author_email": "boris@shminke.ml",
    "download_url": "https://files.pythonhosted.org/packages/73/84/be2116a5e4772c344b9fc02ec6dd1471333cec33384a3e32341e43bef495/tptp_lark_parser-0.2.0.tar.gz",
    "platform": null,
    "description": "..\n  Copyright 2022-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|Binder|\\ |PyPI version|\\ |Anaconda|\\ |CircleCI|\\ |AppveyorCI|\\ |Documentation Status|\\ |codecov|\\ |Zenodo|\n\ntptp-lark-parser\n================\n\n.. attention::\n   The project is inactive.\n\n``tptp-lark-parser`` is a parser for the `TPTP library\n<https://tptp.org>`__ language using the `Lark parser\n<https://github.com/lark-parser/lark>`__. For now, only CNF\nsublanguage is supported.\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 tptp-lark-parser\n\nThe package is also available on ``conda-forge``:\n   \n.. code:: sh\n\n   conda install -c conda-forge tptp-lark-parser\n   \nOne can also run it in a Docker container:\n\n.. code:: sh\n\n   docker build -t tptp-lark-parser https://github.com/inpefess/tptp-lark-parser.git\n   docker run -it --rm -p 8888:8888 tptp-lark-parser jupyter-lab --ip=0.0.0.0 --port=8888\n\nHow to Use\n==========\n\n.. code:: python\n\n   from tptp_lark_parser import TPTPParser\n\n   tptp_parser = TPTPParser()\n   parsed_text = tptp_parser.parse(\"cnf(test, axiom, ~ p(Y, X) | q(X, Y)).\")\n   clause_literals = parsed_text[0].literals\n   \nSee `the\nnotebook <https://github.com/inpefess/tptp-lark-parser/blob/master/notebooks/usage-example.ipynb>`__\nor run it in\n`Binder <https://mybinder.org/v2/gh/inpefess/tptp-lark-parser/HEAD?labpath=usage-example.ipynb>`__\nfor more information.\n\nMore Documentation\n==================\n\nMore documentation can be found\n`here <https://tptp-lark-parser.readthedocs.io/en/latest>`__.\n\nSimilar Projects\n================\n\nThere are many TPTP parsers in different languages:\n\n* `C <https://github.com/TPTPWorld/SyntaxBNF>`__ (by TPTP's creator Geoff Sutcliffe)\n* `Java <https://github.com/marklemay/tptpParser>`__\n* `C++ <https://github.com/leoprover/tptp-parser>`__\n* `JavaScript <https://www.npmjs.com/package/tptp>`__\n* `Rust <https://github.com/MichaelRawson/tptp>`__\n* `Common Lisp <https://github.com/lisphacker/cl-tptp-parser>`__\n* `Scala <https://github.com/leoprover/scala-tptp-parser>`__\n* `Haskell <https://github.com/aztek/tptp>`__\n* `OCaml <https://github.com/Gbury/dolmen>`__\n\nThere also is `another parser in Python <https://github.com/AndrzejKucik/tptp_python_parser>`__ containing only the Lark syntax file.\n\nHow to Cite\n===========\n\nIf you want to cite the `tptp-lark-parser` in your research paper,\nplease use the following doi:\n`<https://doi.org/10.5281/zenodo.7040540>`__.\n\nHow to Contribute\n=================\n\nPlease read `the Code of Conduct\n<https://tptp-lark-parser.readthedocs.io/en/latest/code-of-conduct.html>`__\nand then follow `the contribution guide\n<https://tptp-lark-parser.readthedocs.io/en/latest/contributing.html>`__.\n\n.. |PyPI version| image:: https://badge.fury.io/py/tptp-lark-parser.svg\n   :target: https://badge.fury.io/py/tptp-lark-parser\n.. |CircleCI| image:: https://circleci.com/gh/inpefess/tptp-lark-parser.svg?style=svg\n   :target: https://circleci.com/gh/inpefess/tptp-lark-parser\n.. |Documentation Status| image:: https://readthedocs.org/projects/tptp-lark-parser/badge/?version=latest\n   :target: https://tptp-lark-parser.readthedocs.io/en/latest/?badge=latest\n.. |codecov| image:: https://codecov.io/gh/inpefess/tptp-lark-parser/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/inpefess/tptp-lark-parser\n.. |Binder| image:: https://mybinder.org/badge_logo.svg\n   :target: https://mybinder.org/v2/gh/inpefess/tptp-lark-parser/HEAD?labpath=usage-example.ipynb\n.. |AppveyorCI| image:: https://ci.appveyor.com/api/projects/status/7n0g3a3ag5hjtfi0?svg=true\n   :target: https://ci.appveyor.com/project/inpefess/tptp-lark-parser\n.. |Anaconda| image:: https://anaconda.org/conda-forge/tptp-lark-parser/badges/version.svg\n   :target: https://anaconda.org/conda-forge/tptp-lark-parser\n.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7040540.svg\n   :target: https://doi.org/10.5281/zenodo.7040540\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A TPTP parser using Lark",
    "version": "0.2.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c6ea1c9d19dac7c1b066d7d4cf800280ddb0ccba64cc6566f5c5e14755e056a3",
                "md5": "6124ee4b3278cfdd736f69e67301b0cc",
                "sha256": "ca851fc62fcffae5b91b2b49e92ac0ba39a0a45d43f8949ba48ce9615082de52"
            },
            "downloads": -1,
            "filename": "tptp_lark_parser-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6124ee4b3278cfdd736f69e67301b0cc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.1,<3.12",
            "size": 59346,
            "upload_time": "2023-02-08T17:32:53",
            "upload_time_iso_8601": "2023-02-08T17:32:53.866879Z",
            "url": "https://files.pythonhosted.org/packages/c6/ea/1c9d19dac7c1b066d7d4cf800280ddb0ccba64cc6566f5c5e14755e056a3/tptp_lark_parser-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7384be2116a5e4772c344b9fc02ec6dd1471333cec33384a3e32341e43bef495",
                "md5": "99f04b6c3dee8b3fa2180c41bdca7e03",
                "sha256": "1b0479220b8a889633c2be598c767da9b891cb40d448b9d2505a5dfb5347193b"
            },
            "downloads": -1,
            "filename": "tptp_lark_parser-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "99f04b6c3dee8b3fa2180c41bdca7e03",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.1,<3.12",
            "size": 57702,
            "upload_time": "2023-02-08T17:32:55",
            "upload_time_iso_8601": "2023-02-08T17:32:55.590481Z",
            "url": "https://files.pythonhosted.org/packages/73/84/be2116a5e4772c344b9fc02ec6dd1471333cec33384a3e32341e43bef495/tptp_lark_parser-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-08 17:32:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "inpefess",
    "github_project": "tptp-lark-parser",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "appveyor": true,
    "lcname": "tptp-lark-parser"
}
        
Elapsed time: 0.10007s