Jtypes.Rubicon 0.1.0a2

Description:

jtypes.rubicon 0.1.0a2

**Currently only as placeholder (because a base package jtypes.jvm is still in development)**jtypes.rubicon==============A bridge between the Java Runtime Environment and Python.Overview======== | **jtypes.rubicon** is a bridge between Python and Java, allowing these to intercommunicate. | It is an effort to allow Python programs full access to Java class libraries. `PyPI record`_. | **jtypes.rubicon** is a lightweight Python package, based on the *ctypes* or *cffi* library. | It is an almost fully compliant implementation of Steve Menard's **JPype** package by reimplementing whole its functionality in a clean Python instead of C/C++.About Rubicon-Java:-------------------Borrowed from the `original website`_: 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, and3. A Java JAR file.A ``Makefile`` has been provided to compile the JNI and JAR components. Type:: maketocompilethem.Thecompiledoutputwillbeplacedinthe‘‘dist‘‘directory...admonition::CrossplatformsupportThisMakefilecurrentlyonlyworksunderOS/X;however,thebuildcommandsaren′tcomplicated;itshouldbefairlyeasytoreproducethebuildonotherplatforms.Pullrequeststomakethe‘‘Makefile‘‘cross−platformarewelcome.TouseRubicon−Java,you′llneedtoensure:1.‘‘rubicon.jar‘‘isintheclasspathwhenyoustartyourJavaVM.2.TheRubiconlibraryfileissomewherethatitwillbefoundbydynamiclibrarydiscovery.Thismeans:a.UnderOSX,putthedirectorycontaining‘‘librubicon.dylib‘‘isinyour‘‘DYLDLIBRARYPATH‘‘b.UnderLinux,putthedirectorycontaining‘‘librubicon.so‘‘isinyour‘‘LDLIBRARYPATH‘‘c.UnderWindows....something:−)3.The‘‘rubicon‘‘Pythonmoduleissomewherethatcanbeaddedtoa‘‘PYTHONPATH‘‘.Youcaninstallrubiconusing:: 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`` Pythonmodule.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.orgIt'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 torespond 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 largerapplication 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:./dist2. Build the libraries:: makeclean make all3. Run the test suite:: $ java org.pybee.rubicon.test.TestThis 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 `pybee/general`_ channel on Gitter.We foster a welcoming and respectful community as described in our`BeeWare Community Code of Conduct`_.Contributing------------If you experience problems with this backend, `log them on GitHub`_. If youwant to contribute code, please `fork the code`_ and `submit a pull request`_.Installation============Prerequisites:+ Python 2.7 or higher or 3.4 or higher * http://www.python.org/ * 2.7 and 3.6 are primary test environments.+ pip and setuptools * http://pypi.python.org/pypi/pip * http://pypi.python.org/pypi/setuptoolsTo install run:: python -m pip install --upgrade jtypes.rubiconTo ensure everything is running correctly you can run the tests using:: python -m jt.rubicon.testsDevelopment===========Visit `development page`_Installation from sources:Clone the `sources`_ and run:: python -m pip install ./jtypes.rubiconor on development mode:: python -m pip install --editable ./jtypes.rubiconPrerequisites:+ Development is strictly based on *tox*. To install it run:: python -m pip install toxLicense======= | Copyright (c) 2016-2018, Adam Karpierz | | Licensed under the BSD license | http://opensource.org/licenses/BSD-3-Clause | Please refer to the accompanying LICENSE file.Authors=======* Adam Karpierz <[email protected]>.. _PyPI record: https://pypi.python.org/pypi/jtypes.rubicon.. _original website: https://github.com/pybee/rubicon-java.. _development page: https://github.com/karpierz/jtypes.rubicon.. _sources: https://github.com/karpierz/jtypes.rubicon.. _BeeWare suite: http://pybee.org.. _Rubicon suite: http://pybee.org/rubicon.. _Read The Docs: http://rubicon-java.readthedocs.org.. _@pybeeware on Twitter: https://twitter.com/pybeeware.. _pybee/general: https://gitter.im/pybee/general.. _BeeWare Community Code of Conduct: http://pybee.org/community/behavior/.. _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/pullsChangelog=========0.1.0a2 (2018-11-08)--------------------- Update of the required setuptools version.- Minor setup and tests improvements.0.1.0a0 (2016-11-30)--------------------- Initial version.