diff options
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | README.md | 27 |
2 files changed, 30 insertions, 0 deletions
@@ -1,3 +1,6 @@ +# Makefile to drive tests. You don't need this if you just want to +# use pyzipper yourself. + SRC := $(wildcard demo[0-9]) BIN := $(addsuffix .zip,${SRC}) @@ -9,6 +9,9 @@ just ties it all together with a bow. `demo1` and `demo2` are two trivial sample packages. +The `Makefile` is just a driver for the demos. `pyzipper` itself is +all you need if you want to use this yourself. + Tested with both Python 2 and Python 3, should work with either. How it works @@ -25,3 +28,27 @@ This relies on two somewhat obscure Python features: `demo1` takes advantage of a third obscure feature: the `pkgutil` library's ability to load data files via the `import` system. + +Usage +----- + +This is what `pyzipper --help` returns as of this writing. The +program itself is authoritative, this is just a snapshot for +convenience. + +``` +usage: pyzipper [-h] -o OUTPUT [-m MODULE] [-e EXECUTABLE] source + +Generate an executable Python zip package. + +positional arguments: + source + +optional arguments: + -h, --help show this help message and exit + -o OUTPUT, --output OUTPUT + -m MODULE, --module MODULE + module within package to run (default: main) + -e EXECUTABLE, --executable EXECUTABLE + python executable to run (default: python) +``` |