11) ABOUT 2======== 3 4This is the Python3 package 'antlr3', which is required to use parsers created 5by the ANTLR3 tool. See <http://www.antlr.org/> for more information about 6ANTLR3. 7 8 92) STATUS 10========= 11 12The Python3 target for ANTLR3 is still in beta. Documentation is lacking, some 13bits of the code is not yet done, some functionality has not been tested yet. 14Also the API might change a bit - it currently mimics the Java implementation, 15but it may be made a bit more pythonic here and there. 16 17WARNING: The runtime library is not compatible with recognizers generated by 18ANTLR versions preceding V3.4.x. If you are an application developer, 19then the suggested way to solve this is to package the correct runtime with 20your application. Installing the runtime in the global site-packages directory 21may not be a good idea. 22Sorry for the inconvenience. 23 24 253) DOWNLOAD 26=========== 27 28This runtime is part of the ANTLR distribution. The latest version can be found 29at <http://www.antlr.org/download.html>. 30 31If you are interested in the latest, most bleeding edge version, have a look at 32the git repository at <http://github.com/antlr/antlr3>. 33 34 354) INSTALLATION 36=============== 37 38Just like any other Python package: 39$ python3 setup.py install 40 41See <http://docs.python.org/inst/> for more information. 42 43 445) DOCUMENTATION 45================ 46 47Documentation (as far as it exists) can be found in the wiki 48<http://www.antlr.org/wiki/display/ANTLR3/Antlr3Python3Target> 49 50 516) REPORTING BUGS 52================= 53 54Please file bug reports on github: <http://github.com/antlr/antlr3>. 55 56 577) HACKING 58========== 59 60Only the runtime package can be found here. There are also some StringTemplate 61files in 'src/org/antlr/codegen/templates/Python3/' and some Java code in 62'src/org/antlr/codegen/Python3Target.java' (of the main ANTLR3 source 63distribution). 64 65If there are no directories 'tests' and 'unittests' in 'runtime/Python3', you 66should fetch the latest ANTLR3 version from the perforce depot. See section 67DOWNLOAD. 68You'll need java and ant in order to compile and use the tool. 69Be sure to properly setup your CLASSPATH. 70(FIXME: is there some generic information, how to build it yourself? I should 71point to it to avoid duplication.) 72 73You can then use the commands 74$ python3 setup.py unittest 75$ python3 setup.py functest 76to ensure that changes do not break existing behaviour. 77 78Please send patches as pull requests on github. For larger code contributions 79you'll have to sign the "Developer's Certificate of Origin", which can be 80found on <http://www.antlr.org/license.html> or use the feedback form at 81<http://www.antlr.org/misc/feedback>. 82