Commits

<tat...@gmail.com  committed ad6ef1d

  • Participants
  • Parent commits 7555c13

Comments (0)

Files changed (1)

-== Welcome ==
-
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
-
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/estin/sadisplay/wiki
-}}}
-
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-
-=== Syntax highlighting ===
-
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+= sadisplay =
+
+Simple package for describing SQLAlchemy schema. Works with mapped classes. Relation detecting by ForeignKey columns. Supports mapped class inherit.
+
+Output formats:
+* [[http://plantuml.sourceforge.net/|PlantUML]] class diagram
+
+== Usage ==
+Write simple script in your project environment:
+{{{
+#!python
+import sadisplay
+from yourapp import model
+
+desc = sadisplay.describe([getattr(model, attr) for attr in dir(model)])
+open('schema.plantuml', 'w').write(sadisplay.plantuml(desc))
+
+# Or only part of schema
+desc = sadisplay.describe([model.User, model.Group, model.Permission])
+open('auth.plantuml', 'w').write(sadisplay.plantuml(desc))
+
+}}}
+
+=== Render PlantUML class diagram ===
+{{{
+$ java -jar plantuml.jar schema.plantuml
+}}}
+
+Or for svg format
+{{{
+$ java -jar plantuml.jar -Tsvg schema.plantuml
+}}}
+
+[[Gallery]]