11) ABOUT 2======== 3 4This is the Python 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 Python 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: Currently the runtime library for V3.1 is not compatible with 18recognizers generated by ANTLR V3.0.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. 22It is still undetermined, if a future release of the V3.1 runtime will be 23compatible with V3.0.x recognizers or if future runtimes V3.2+ will be 24compatible with V3.1 recognizers. 25Sorry for the inconvenience. 26 27 283) DOWNLOAD 29=========== 30 31This runtime is part of the ANTLR distribution. The latest version can be found 32at <http://www.antlr.org/download.html>. 33 34If you are interested in the latest, most bleeding edge version, have a look at 35the perforce depot at <http://fisheye2.cenqua.com/browse/antlr>. There are 36tarballs ready to download, so you don't have to install the perforce client. 37 38 394) INSTALLATION 40=============== 41 42Just like any other Python package: 43$ python setup.py install 44 45See <http://docs.python.org/inst/> for more information. 46 47 485) DOCUMENTATION 49================ 50 51Documentation (as far as it exists) can be found in the wiki 52<http://www.antlr.org/wiki/display/ANTLR3/Antlr3PythonTarget> 53 54 556) REPORTING BUGS 56================= 57 58Please send bug reports to the ANTLR mailing list 59<http://www.antlr.org:8080/mailman/listinfo/antlr-interest> or 60<pink@odahoda.de>. 61 62Existing bugs may appear someday in the bugtracker: 63<http://www.antlr.org:8888/browse/ANTLR> 64 65 667) HACKING 67========== 68 69Only the runtime package can be found here. There are also some StringTemplate 70files in 'src/org/antlr/codegen/templates/Python/' and some Java code in 71'src/org/antlr/codegen/PythonTarget.java' (of the main ANTLR3 source 72distribution). 73 74If there are no directories 'tests' and 'unittests' in 'runtime/Python', you 75should fetch the latest ANTLR3 version from the perforce depot. See section 76DOWNLOAD. 77You'll need java and ant in order to compile and use the tool. 78Be sure to properly setup your CLASSPATH. 79(FIXME: is there some generic information, how to build it yourself? I should 80point to it to avoid duplication.) 81 82You can then use the commands 83$ python setup.py unittest 84$ python setup.py functest 85to ensure that changes do not break existing behaviour. 86 87Please send patches to <pink@odahoda.de>. For larger code contributions you'll 88have to sign the "Developer's Certificate of Origin", which can be found on 89<http://www.antlr.org/license.html> or use the feedback form at 90<http://www.antlr.org/misc/feedback>. 91