jip 0.4

License

jip itself is distributed according to MIT License .

Install

jip is required to run within virtualenv, which is a best practice for python/jython developers to created a standalone, portable environment.

Create virtualenv with jython:

virtualenv -p /usr/local/bin/jython jython-env

Activate the shell environment:

cd jython-dev
source bin/activate

Download and install jip with pip:

pip install jip

Usage

jip install <groupId>:<artifactId>:<version>

jip install org.springframework:spring-core:3.0.5.RELEASE

jip resolve pom.xml

jip deps info.sunng.gefr:gefr:0.2-SNAPSHOT

jip update info.sunng.bason:bason-annotation:0.1-SNAPSHOT

jip remove org.springframework:spring-core:3.0.5.RELEASE

Configuration

You can configure custom maven repository with a dot file, jip will search configurations in the following order:

1. $VIRTUAL_ENV/.jip, your virtual environment home

2. $HOME/.jip, your home

Here is an example:

[repos:jboss]
uri=http://repository.jboss.org/maven2/
type=remote

[repos:local]
uri=/home/sun/.m2/repository/
type=local

[repos:central]
uri=http://repo1.maven.org/maven2/
type=remote

Be careful that the .jip file will overwrite default settings, so you must include default local and central repository explicitly. jip will skip repositories once it finds package matches the maven coordinator.

From 0.4, you can also define repositories in pom.xml if you use the resolve command. jip will add these custom repositories with highest priority.

Distribution helpers

From 0.4, you can use jip in your setup.py to simplify jython source package distribution. Create pom.xml in the same directory with setup.py. Fill it with your Java dependencies in standard way. In this file, you can also define custom repositories. Here is an example:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

    ...

    <dependencies>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.6.1</version>
        </dependency>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.6.1</version>
        </dependency>

        ...

    </dependencies>

    <repositories>
        <repository>
            <id>sonatype-oss-sonatype</id>
            <url>http://oss.sonatype.org/content/repositories/snapshots/</url>
        </repository>
    </repositories>
</project>

And in your setup.py, use the jip setup wrapper instead of the one provided by setuptools or distutils. You can add keyword argument pom to specify a custom name of the pom file.

from jip.dist import setup

Other than the traditional pom configuration, jip also allows you to describe dependencies in python. You can define a data structure in your setup.py like:

requires_java = {
    'dependencies':[
        ## (groupdId, artifactId, version)
        ('org.slf4j', 'slf4j-api', '1.6.1'),
        ('org.slf4j', 'slf4j-log4j12', '1.6.1'),
        ('info.sunng.soldat', 'soldat', '1.0-SNAPSHOT'),
        ('org.apache.mina', 'mina-core', '2.0.2')
    ],
    'repositories':[
        ('sonatype-oss-snapshot', 'http://oss.sonatype.org/content/repositories/snapshots/')
    ]
}

And pass it to jip setup as keyword argument requires_java. Once jip found this argument, it won’t try to load a pom file.

from jip.dist import setup
setup(
    ...
    requires_java=requires_java,
    ...)

Another resolve command was added to setuptools, you can use this command to download all dependencies to library path

jython setup.py resolve

All dependencies will be installed when running

jython setup.py install

So with jip’s setup() wrapper, pip will automatically install what your package needs. You can publish your package to python cheese shop, and there is just one command for everything

pip install [your-package-name]

Change Notes

Links

• Don’t repeat yourself: Distribute jython packages with jip.dist

• Obsolete Introduction to jip 0.1

• Project on Github

• Package on Python Cheese Shop