snakefight

snakefight generates WAR files from Python (Jython) WSGI applications, suitable for deployment to Java Servlet containers.

Installation

snakefight requires at least Jython 2.5b2. To install:

$ easy_install snakefight

Creating WAR files

snakefight provides a new distutils command: bdist_war.

To create a WAR file, create a web.xml deployment descriptor (which would typically utilize the modjy library for the actual Servlet) and run:

$ jython setup.py bdist_war --web-xml web.xml

snakefight can automatically generate a web.xml (utilizing modjy) for Paste style projects (those that support the paste.app_factory entry point), by specifying the --paste-config option. To specify a named app in the config file, use the --paste-app-name option (which defaults to main):

$ jython setup.py bdist_war --paste-config production.ini --paste-app-name cascade

To include separate .jar files in the WAR's WEB-INF/lib directory, specify a comma separated list of jars to the --include-jars option:

$ jython setup.py bdist_war --include-jars jasper-runtime-5.5.9.jar,lucene-core-2.4.jar \
> --web-xml web.xml

As with any distutils command the options may also be specified in the project's setup.cfg:

[bdist_war]
paste-config = production.ini
include-jars = jasper-runtime-5.5.9.jar
               lucene-core-2.4.jar

snakefight can also be ran from CPython (at least version 2.5) as long as a JYTHON_HOME is specified:

$ jython setup.py bdist_war --web-xml web.xml --jython-home=~/jython2.5b2

Other options:

• --war-prefix Prefix of the war file to build
• --no-jython Don't include the Jython distribution

TODO

Add options for:

• exclude-requires: exclude certain eggs from inclusion
• static_files: list of directories to serve public files (through the faster org.jruby.webapp.FileServlet)
• specifying modjy options
• --unpacked: don't zip the war file

Support:

• non setuptools apps? (like Django apps) django-jython already handles Django but ideally we'd share code

Changelog