/drawpack

Generates SVG package diagrams from a directory structure

Primary LanguagePythonApache License 2.0Apache-2.0

drawpack

A handy tool for generating package diagrams from directory structure. Gives instant insight into the project structure and greatly simplifies documenting software architecture.

Features

  • Generates SVG package diagrams from directory structure
  • Independent of the programming language
  • Supports Java packages
  • 3 predefined color schemes
  • Combined with ImageMagick , generates PNG diagrams

Usage examples

  • Standalone
    • python draw.py path max_indent base_color [main package prefix]
    • python draw.py test 3 blue > diagram.svg
  • With ImageMagick
    • ./draw.sh test my_project 3 blue
  • With Java base package name
    • ./draw.sh ~/spring-framework-master/spring-core/src/main/java/org/springframework/core/ core 3 blue org.springframework.core
  • For any other language
    • ./draw.sh ~/django-master/django/ django 2 yellow

Examples

  • Spring core package diagram Spring core package diagram
  • Django package diagram Django package diagram