Improved the build process and added instructions for building jars

Author: agronholm

CHANGES.rst

@@ -3,6 +3,7 @@ v2.0.1
 
 * Use super() to call superclass constructors in combo/list models as
   originally intended
+* Added instructions for building jars
 
 
 v2.0.0

README.rst

@@ -16,14 +16,53 @@ Included in this package:
 * shortcuts for loading resources (images or generic data) via class loaders
 * shortcuts for basic dialogs
 * enhanced file selection dialogs
-* wrappers for loading `JFormDesigner <http://www.jformdesigner.com/>`_ forms
+* wrappers for loading `JFormDesigner`_ forms
 * decorators and functions for safely accessing the GUI from any thread
 * support for running background tasks in separate threads
 
 Requires Jython 2.7 or later.
 
-Documentation can be found at the Jython-Swingutils
-`documentation repository <http://packages.python.org/jython-swingutils/>`_
+Documentation can be found at the Python Packaging
+`documentation repository`_.
 
-The source code and the issue tracker can be found at
-`Bitbucket <http://bitbucket.org/agronholm/jython-swingutils/>`_.
+The `source code`_ and the `issue tracker`_ can be found at GitHub.
+
+
+Building jar files
+------------------
+
+To build a jar file, you need to tell ant where to find jython.jar, by
+defining the ``jythonjarpath`` property, either as a command line option
+to ant, or in the ``build.properties`` file.
+
+To build a jar file containing the Python source files::
+
+    ant srcjar
+
+To build a jar containing compiled bytecode files::
+
+    ant binjar
+
+
+Building signed jar files
+-------------------------
+
+Signing the jar files requires three additional properties to be defined:
+``signer``, ``storepass`` and ``keypass``. It also requires that you have a
+matching code signing key in your keystore (``~/.keystore``).
+
+
+To build a signed source jar::
+
+    ant signsrcjar
+
+To build a signed, compiled jar (suitable for `Java Web Start`_)::
+    
+    ant signbinjar
+
+
+.. _JFormDesigner: http://www.jformdesigner.com/
+.. _source code: https://github.com/jython/swingutils
+.. _issue tracker: https://github.com/jython/swingutils/issues
+.. _documentation repository: http://packages.python.org/jython-swingutils/
+.. _Java Web Start: http://docs.oracle.com/javase/tutorial/deployment/webstart/

RELEASE

@@ -0,0 +1 @@
+2.0.1

build.xml

@@ -5,8 +5,8 @@
     "version" properties to build this. To sign the (source or binary) jar, you also
     need to provide the "signer", "storepass", "keypass" properties. -->
     <property file="build.properties"/>
-    <property name="srcjarfile" location="dist/jython-swingutils-${version}.jar" />
-    <property name="binjarfile" location="dist/jython-swingutils-${version}-bin.jar" />
+	<loadfile property="release" srcfile="RELEASE"/>
+    <property name="jarfile" location="dist/jython-swingutils-${release}.jar" />
 
     <target name="clean">
         <delete dir="build"/>
@@ -25,26 +25,26 @@
 
     <target name="srcjar">
         <mkdir dir="dist"/>
-        <delete file="${srcjarfile}" />
-        <jar destfile="${srcjarfile}">
+        <delete file="${jarfile}" />
+        <jar destfile="${jarfile}">
             <fileset dir="." includes="swingutils/**/*.py"/>
         </jar>
     </target>
 
     <target name="binjar" depends="clean, compile">
         <mkdir dir="dist"/>
-        <delete file="${binjarfile}" />
-        <jar destfile="${binjarfile}">
+        <delete file="${jarfile}" />
+        <jar destfile="${jarfile}">
             <fileset dir="build" includes="**/*.class"/>
         </jar>
     </target>
 
     <target name="signbinjar" depends="binjar">
-        <signjar jar="${binjarfile}" alias="${signer}" storepass="${storepass}" keypass="${keypass}" />
+        <signjar jar="${jarfile}" alias="${signer}" storepass="${storepass}" keypass="${keypass}" />
     </target>
 
     <target name="signsrcjar" depends="srcjar">
-        <signjar jar="${srcjarfile}" alias="${signer}" storepass="${storepass}" keypass="${keypass}" />
+        <signjar jar="${jarfile}" alias="${signer}" storepass="${storepass}" keypass="${keypass}" />
     </target>
 
 </project>

setup.py

@@ -6,10 +6,11 @@
     raise Exception('This package can only be installed on Jython.')
 
 long_description = open('README.rst').read()
+version = open('RELEASE').read()
 
 setup(
     name='jython-swingutils',
-    version='2.0.1',
+    version=version,
     description="Makes using Java's Swing UI toolkit easy on Jython",
     long_description=long_description,
     author='Alex Gronholm',