summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillaume Seguin <guillaume@segu.in>2009-10-24 02:06:31 +0200
committerGuillaume Seguin <guillaume@segu.in>2009-10-24 02:06:31 +0200
commit664c2433b6bbc67a62e02381f68b4cca4ca2c8cb (patch)
tree3d57fe9c49112da594d25e24e3f210281c881b4c
parent8d3ee91dc6345cc360519c6ce77177332a612299 (diff)
downloadumlpy-664c2433b6bbc67a62e02381f68b4cca4ca2c8cb.tar.gz
umlpy-664c2433b6bbc67a62e02381f68b4cca4ca2c8cb.tar.bz2
Add result for umlpy source
-rw-r--r--README14
-rw-r--r--umlpy.pngbin0 -> 79495 bytes
2 files changed, 8 insertions, 6 deletions
diff --git a/README b/README
index a0d01e0..80428ce 100644
--- a/README
+++ b/README
@@ -2,6 +2,13 @@ This software produces a class relationship UML-like graph from a given set of
Python source files. It uses graphviz Python bindings and the dot layout for
graph generation and epydoc internals for source introspection.
+The most basic usage of this software is to simply pass it the name of the
+modules you want to graph (you obviously need to be in the right directory) :
+ $ python umlpy.py mysource.py mymodule
+The result will be written to the uml.pdf file by default. The output filename
+can be modified using the -o (or --output) option. The output format is set
+using one of the --png, --pdf and --jpg options.
+
This software will, by default (without any specific code documentation) display
the classes hierarchy. Using the --all-methods or --all-properties options, il
will also display the methods and/or properties of each class under the class
@@ -26,12 +33,7 @@ docstrings. The example.png file shows the corresponding output, which was
produced by running
$ python umlpy.py --png -o example.png -p "example."
-The most basic usage of this software is to simply pass it the name of the
-modules you want to graph (you obviously need to be in the right directory) :
- $ python umlpy.py mysource.py mymodule
-The result will be written to the uml.pdf file by default. The output filename
-can be modified using the -o (or --output) option. The output format is set
-using one of the --png, --pdf and --jpg options.
+The umlpy.png file shows the software output for its own source file.
Class names can be shortened using a common prefix specified with the -p option.
For instance, if you are working on a module called verylongmodulename, you can
diff --git a/umlpy.png b/umlpy.png
new file mode 100644
index 0000000..441e850
--- /dev/null
+++ b/umlpy.png
Binary files differ