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.2.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: diagramtool-1.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 c7f184f3fa950caf71965394a0c63056d9584b6e3c0039d216b8feeec9df93bf
MD5 d94ae3f55e820bd760dd474902021736
BLAKE2b-256 bed1465559878557f200a3a5ffc49422d9e24cafeb0d4087970e3a38b5942ab0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: DiagramTool-1.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 908ece09d045cac9c039e4ff2fafda4c7befdb525525fed7a403841353b3d7ec
MD5 4118acd4c40c8a3bfae1ef019127e007
BLAKE2b-256 f12ccb650292b385626f0b0a6e94772a7549e54feefa6e3184a3555d457e87c7

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