Metadata-Version: 1.1
Name: rubicon-java
Version: 0.1.0
Summary: A bridge interface between Python and Java.
Home-page: http://pybee.org/rubicon
Author: Russell Keith-Magee
Author-email: russell@keith-magee.com
License: New BSD
Description: Rubicon-Java
        ============
        
        Rubicon-Java is a bridge between the Java Runtime Environment and Python.
        It enables you to:
        
        * Instantiate objects defined in Java,
        * Invoke static and instance methods on objects defined in Java,
        * Access and modify static and instance fields on objects defined in Java, and
        * Write and use Python implementations of interfaces defined in Java.
        
        Quickstart
        ----------
        
        Rubicon-Java consists of three components:
        
        1. A Python library,
        2. A JNI library, and
        3. A Java JAR file.
        
        A ``Makefile`` has been provided to compile the JNI and JAR components. Type::
        
            $ make
        
        to compile them. The compiled output will be placed in the ``dist`` directory.
        
        .. admonition:: Cross platform support
        
            This Makefile currently only works under OS/X; however, the build commands
            aren't complicated; it should be fairly easy to reproduce the build on other
            platforms. Pull requests to make the ``Makefile`` cross-platform are welcome.
        
        To use Rubicon-Java, you'll need to ensure:
        
        1. ``rubicon.jar`` is in the classpath when you start your Java VM.
        
        2. The Rubicon library file is somewhere that it will be found by dynamic
           library discovery. This means:
        
           a. Under OS X, put the directory containing ``librubicon.dylib`` is in your ``DYLD_LIBRARY_PATH``
        
           b. Under Linux, put the directory containing ``librubicon.so`` is in your ``LD_LIBRARY_PATH``
        
           c. Under Windows.... something :-)
        
        3. The ``rubicon`` Python module is somewhere that can be added to a
           ``PYTHONPATH``. You can install rubicon using::
        
               $ pip install rubicon-java
        
           If you do this, you'll need to reference your system Python install when
           setting your ``PYTHONPATH``.
        
        The Rubicon bridge starts on the Java side. Import the Python object::
        
            import org.pybee.rubicon.Python;
        
        Then start the Python interpreter, and run a Python file::
        
            # Initialize the Python VM
            String pythonHome = "/path/to/python";
            String pythonPath = "/path/to/dir1:/path/to/dir2";
            if (Python.start(pythonHome, pythonPath, null) != 0) {
                System.out.println("Error initializing Python VM.");
            }
        
            # Start a Python script
            if (Python.run("/path/to/script.py") != 0) {
                System.out.println("Error running Python script.");
            }
        
            # Shut down the Python VM.
            Python.stop();
        
        The ``PYTHONPATH`` you specify must enable access to the ``rubicon`` Python
        module.
        
        In your Python script, you can then reference Java objects::
        
            >>> from rubicon.java import JavaClass
        
            # Wrap a Java class
            >>> URL = JavaClass("java/net/URL")
        
            # Then instantiate the Java class, using the API
            # that is exposed in Java.
            >>> url = URL("http://pybee.org")
        
            # You can then call methods on the Java object as if it
            # were a Python object.
            >>> print url.getHost()
            pybee.org
        
        It's also possible to provide implementations of Java Interfaces in Python.
        For example, lets say you want to create a Swing Button, and you want to
        respond to button clicks::
        
            >>> from rubicon.java import JavaClass, JavaInterface
        
            # Wrap the Java interface
            >>> ActionListener = JavaInterface('java/awt/event/ActionListener')
        
            # Define your own implementation
            >>> class MyActionListener(ActionListener):
            ...     def actionPerformed(self, event):
            ...         print "Button Pressed"
        
            # Instantiate an instance of the listener
            >>> listener = MyActionListener()
        
            # Create a button, and set the listener
            >>> Button = JavaClass('javax/swing/JButton')
            >>> button = Button('Push it')
            >>> button.setActionListener(listener)
        
        Of course, this sample code won't work unless it's in the context of a larger
        application starting a Swing GUI and so on.
        
        Testing
        -------
        
        To run the Rubicon test suite:
        
        1. Configure your shell environment so that the Python, Java, and Rubicon
           dynamic libraries can be discovered by the dynamic linker.
        
           * On OSX, using Python 2.7.7 built under Homebrew::
        
                export DYLD_LIBRARY_PATH=/usr/local/Cellar/python/2.7.7_2/Frameworks/Python.framework/Versions/2.7/lib/:`/usr/libexec/java_home`/jre/lib/server:./dist
        
        2. Build the libraries::
        
            $ make clean
            $ make all
        
        3. Run the test suite::
        
            $ java org.pybee.rubicon.test.Test
        
        This is a Python test suite, invoked via Java.
        
        .. Documentation
        .. -------------
        
        .. Full documentation for Rubicon can be found on `Read The Docs`_.
        
        Community
        ---------
        
        Rubicon is part of the `BeeWare suite`_. You can talk to the community through:
        
        * `@pybeeware on Twitter`_
        
        * The `BeeWare Users Mailing list`_, for questions about how to use the BeeWare suite.
        
        * The `BeeWare Developers Mailing list`_, for discussing the development of new features in the BeeWare suite, and ideas for new tools for the suite.
        
        Contributing
        ------------
        
        If you experience problems with this backend, `log them on GitHub`_. If you
        want to contribute code, please `fork the code`_ and `submit a pull request`_.
        
        .. _BeeWare suite: http://pybee.org
        .. _Read The Docs: http://rubicon-java.readthedocs.org
        .. _@pybeeware on Twitter: https://twitter.com/pybeeware
        .. _BeeWare Users Mailing list: https://groups.google.com/forum/#!forum/beeware-users
        .. _BeeWare Developers Mailing list: https://groups.google.com/forum/#!forum/beeware-developers
        .. _log them on Github: https://github.com/pybee/rubicon-java/issues
        .. _fork the code: https://github.com/pybee/rubicon-java
        .. _submit a pull request: https://github.com/pybee/rubicon-java/pulls
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Java
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Software Development :: Widget Sets
