README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

jarsnap.py
==========

Make fat jars

jarsnap.py helps you create deployable executable JAR files by combining
libraries and your main program into a single archive.

Usage
-----

Its most basic usage is as follows:

    $ jarsnap -m Main myprog.jar lib1.jar lib2.jar

This creates a runnable JAR from the three JAR inputs with Main as the main
class. There are other options available as well. Use `jarsnap --help` for more
information.

The installation (see below) also provides a `jarsnap` module which has the
functions `make_fat_jar()` and `main()` which can be used when making other
user interfaces to jarsnap.py's functionality.

Installation
------------

jarsnap.py can be installed using the Python setuptools module. It must be
installed to automate the installation.

    # python3 setup.py install

Hacking
-------

We strive to be [PEP 8][4] compliant, but there are exceptions to every
rule. jarsnap.py is [free software][2], released under version 3 of the GNU
Affero General Public License. You are free to copy, share, and modify the
software under those terms. See [COPYING](COPYING) for more details.

To submit a patch, [submit your diff to Delwink][3] or us GitHub's pull request
system.

[2]: http://gnu.org/philosophy/free-sw.html
[3]: mailto:contribute@delwink.com
[4]: https://www.python.org/dev/peps/pep-0008/