pylucene 3.5.0-3
[pylucene.git] / jcc / DESCRIPTION
1
2 For changes since earlier releases, see:
3   http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc/CHANGES
4
5 JCC is a C++ code generator for producing the code necessary to call
6 into Java classes from CPython via Java's Native Invocation Interface (JNI).
7
8 JCC generates C++ wrapper classes that hide all the gory details of JNI
9 access as well Java memory and object reference management.
10
11 JCC generates CPython types that make these C++ classes accessible from a
12 Python interpreter. JCC attempts to make these Python types pythonic by
13 detecting iterators and property accessors. Iterators and mappings may also
14 be declared to JCC.
15
16 JCC has been built on Python 2.3, 2.4, 2.5, 2.6 and 2.7 and has been used with
17 various Java Runtime Environments such as Sun Java 1.4, 1.5 and 1.6, Apple's
18 Java 1.4 and 1.5 on Mac OS X and open source Java OpenJDK 1.7 builds.
19
20 An experimental port to Python 3 is available from a branch:
21   http://svn.apache.org/repos/asf/lucene/pylucene/branches/python_3/jcc/
22
23 JCC is supported on Mac OS X, Linux, Solaris and Windows.
24
25 JCC is written in C++ and Python. It uses Java's reflection API to do its
26 job and needs a Java Runtime Environment to be present to operate.
27
28 JCC is built with distutils or setuptools::
29
30     python setup.py build
31     sudo python setup.py install
32
33 Setuptools is required to build JCC on Python 2.3.
34
35 Except for Mac OS X - where Apple's Java comes pre-installed in a known
36 framework location - JCC's setup.py file needs to be edited before building
37 JCC to specify the location of the Java Runtime Environment's header files
38 and libraries.
39
40 The svn sources for JCC are available at:
41   http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc/
42
43 For more information about JCC see:
44   http://lucene.apache.org/pylucene/jcc/index.html
45
46 JCC comes with an Apache 2.0 copyright license:
47   http://www.apache.org/licenses/LICENSE-2.0