MerrimanInd/drawpyo

Add ClassDiagram implementation

Open

#53 opened on Feb 7, 2025

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (49 forks)auto 404
diagramTypeenhancementhelp wanted

Repository metrics

Stars
 (410 stars)
PR merge metrics
 (PR metrics pending)

Description

As a programmer, I want to be able to automatically create diagrams from a Python module that has its objects defined and annotated with pydantic. As much as reasonable, I'd want to comply with UML diagrams. This is already a stub implementation of ClassDiagram but it's going to take a lot more effort - because this is no preset ordering of classes, and there may/will be multiple dependencies, the positioning of classes on the page is going to be very different from e.g. a tree diagram.

Contributor guide

Research direction
Examine the existing stub implementation of ClassDiagram and understand how other diagrams (e.g., tree) position elements. Study UML class diagram layout algorithms to handle unordered classes with dependencies.
Tech stack
python
Domain
toolingbackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonpydanticGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60