Skip to main content

A tool to create diagrams from code

Project description

Diagram Tool

Description

Python script for creating UML diagrams from source code.

  • Can parse multiple languages:
    • Python
    • Javascript (not yet implemented)
    • Typescript (not yet implemented)
  • Generate a SVG file with the diagram

Usage

Command Line

Use diagramTool command to generate the diagram.

diagramTool [options] <source> <output>

Options

use diagramTool --help to see the available options:

usage: DiagramTool [-h] [--debug] [--dump] [--save-ast] source output

create a class diagram from source code

positional arguments:
  source      source code main file
  output      output file

options:
  -h, --help  show this help message and exit
  --debug     print debug information
  --dump      dump parsed data to stdout
  --save-ast  save ast to file

From Python

import diagramTool as dt

dt.fromSource(source, output, save_ast=False, dump=False, showBorder=False)

Example

Example

Class diagram of this project generated with the tool.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

diagramtool-1.0.1.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

DiagramTool-1.0.1-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file diagramtool-1.0.1.tar.gz.

File metadata

  • Download URL: diagramtool-1.0.1.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for diagramtool-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4643da2eadfb449c9816042587cc58f21218bbeb013a721239686b4350dd7b03
MD5 8094ba3fc602bf9cf900ac61f3ec710c
BLAKE2b-256 1d8b70c44aa80ea5409954888e11dd20373aaa5a3441a096a82490f615310462

See more details on using hashes here.

File details

Details for the file DiagramTool-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: DiagramTool-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for DiagramTool-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 207f5b245e6b032e4f4592c80a22a4c7212b52413ac761f857871e8216e2bde6
MD5 57b866afc81571a12e35bbe3a0983cfa
BLAKE2b-256 5e964f4833a4582266a199b9bacf213987dca6f563c1a93156c6cd2f0f465055

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page