Python app for visualizing class diagrams for a Frappe Framework App using PlantUML
Project description
Frappe App Visualizer
A python app for visualizing class diagrams of a Frappe App's doctypes using PlantUML
Dependencies
Installation
$ pip install frappeviz
Usage
Command Line
$ frappeviz [-h] [--output output-dir] [--format {txt,img,all}]
frappe-app-directory
Example
$ frappeviz path/to/frappe/app/dir -o /path/to/output/dir -f img
Module
>>> from frappeviz import generate_uml
>>> generate_uml('path/to/frappe/app/dir', '/path/to/output/dir' 'img')
Arguments
- -h: help
- --output / -o: output directory
- --format / -f: Output format (txt | img | all)
- frappe directory
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
frappeviz-0.0.2.tar.gz
(4.5 kB
view hashes)
Built Distribution
Close
Hashes for frappeviz-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bad1fbbdaf004c478c01eada789bf6c9d9ea6a14ae8f04105e014714f13cf72 |
|
MD5 | ee2eb7cfa69caa73545bef7ad4306b86 |
|
BLAKE2b-256 | 8971bc89e7db7d9836753d3f1fa7fa72228773612f47a797bf3bcf39648b6169 |