Metadata-Version: 2.4
Name: antlerinator
Version: 4.9.2
Summary: ANTLeRinator
Home-page: https://github.com/renatahodovan/antlerinator
Author: Renata Hodovan, Akos Kiss
Author-email: hodovan@inf.u-szeged.hu, akiss@inf.u-szeged.hu
License: BSD
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Code Generators
License-File: LICENSE.rst
Requires-Dist: antlr4-python2-runtime==4.9.2; python_version ~= "2.7"
Requires-Dist: antlr4-python3-runtime; python_version >= "3.0"
Requires-Dist: typing; python_version < "3.5"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinxcontrib-runcmd; extra == "docs"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

============
ANTLeRinator
============

.. image:: https://img.shields.io/pypi/v/antlerinator?logo=python&logoColor=white
   :target: https://pypi.org/project/antlerinator/
.. image:: https://img.shields.io/pypi/l/antlerinator?logo=open-source-initiative&logoColor=white
   :target: https://pypi.org/project/antlerinator/
.. image:: https://img.shields.io/github/workflow/status/renatahodovan/antlerinator/main/master?logo=github&logoColor=white
   :target: https://github.com/renatahodovan/antlerinator/actions

.. start included documentation

*ANTLeRinator* is a Python utility package to help keeping components of
ANTLR v4 in sync.


Requirements
============

* Python_ ~= 2.7 or >= 3.5
* pip_ and setuptools Python packages (the latter is automatically installed by
  pip)
* Java_ SE >= 7 JRE or JDK (the latter is optional)

.. _Python: https://www.python.org
.. _pip: https://pip.pypa.io
.. _Java: https://www.oracle.com/java/


Install
=======

The quick way::

    pip install antlerinator

Alternatively, by cloning the project and running setuptools::

    python setup.py install


Usage
=====

A common form of *ANTLeRinator*'s usage:

.. code-block:: python

    import antlerinator
    import argparse
    import subprocess

    parser = argparse.ArgumentParser()
    parser.add_argument('--antlr', default=antlerinator.antlr_jar_path)
    args = parser.parse_args()

    if args.antlr == antlerinator.antlr_jar_path:
        antlerinator.install(lazy=True)
    subprocess.call(['java', '-jar', args.antlr])

Should there be need for manual jar installation, a helper script is available::

    antlerinator-install

.. end included documentation


Copyright and Licensing
=======================

Licensed under the BSD 3-Clause License_.

.. _License: LICENSE.rst
