https://github.com/yemikudaisi/frappeviz

Python app for visualizing class diagrams for a Frappe Framework App using PlantUML
https://github.com/yemikudaisi/frappeviz

frappe-framework plantuml uml-class-diagram

Last synced: about 1 month ago
JSON representation

Python app for visualizing class diagrams for a Frappe Framework App using PlantUML

• Host: GitHub
• URL: https://github.com/yemikudaisi/frappeviz
• Owner: yemikudaisi
• License: mit
• Created: 2020-09-07T12:24:51.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-02T16:15:18.000Z (over 2 years ago)
• Last Synced: 2024-05-06T20:44:23.411Z (about 1 month ago)
• Topics: frappe-framework, plantuml, uml-class-diagram
• Language: Python
• Homepage:
• Size: 66.4 KB
• Stars: 28
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-frappe - Frappeviz - Visualize class diagrams of a Frappe App's doctypes using PlantUML. (Uncategorized / Uncategorized)

README

        
# Frappe App Visualizer

A python app for visualizing class diagrams of a [Frappe App's](https://frappeframework.com/) doctypes using [PlantUML](https://plantuml.com/)

![Screenshot](https://github.com/yemikudaisi/frappe_viz/raw/master/docs/library_management.png)

## Dependencies

- [Python 3](https://www.python.org/download/releases/3.0/)

- [PlantUML](https://pypi.org/project/plantuml/)

## Installation

```

$ pip install frappeviz

```

## Usage

### Command Line

```

$ frappeviz [-h] [--output output-dir] [--format {txt,img,all}]

                 frappe-app-directory

```

#### Arguments

- -h: help

- --output / -o: output directory

- --format / -f: Output format (txt | img | all)

- frappe directory

#### Example

```sh

$ frappeviz path/to/frappe/app/dir -o /path/to/output/dir -f img

```

### Module

```python

>>> from frappeviz import generate_uml

>>> generate_uml('path/to/frappe/app/dir', '/path/to/output/dir' 'img')

```

The UML for each module in the app is generated in separate files (PlantUML text and .png images) that shares the same name as the app's respective modules.

## Supported Environment

Tested on the following OS:

- Ubuntu OS

- macOS