Cameronsplaze/AWS-ContainerManager

[Documentation Improvement] Add `pyreverse` generated docs to the Repo

Open

#115 opened on Apr 7, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (0 forks)auto 404
documentationenhancementgood first issue

Repository metrics

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

Description

Is your feature request related to a problem? Please describe.

Pyreverse (A sub-piece of pylint) generates a diagram on libraries, and how they link together. See if there's a way to add the .dot files it generates, to the README.

So far I got:

pyreverse --help
pyreverse ContainerManager --colorized -ASmy

But at first glance, there's modules it's missing. I'm guessing we'll need to add __init__.py files, and/or add paths to modules to existing ones.

After that, see how to render *.dot inside of markdown, or if there's a way to change the extension.

Describe the solution you'd like

Either files generated (Probably won't worry about automating it, having actions push code gets messy) and docs on how to re-create the image each time, or this ticket is a wont-do.

Describe alternatives you've considered

Just leave things as is... Not having this isn't huge.

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

Contributor guide

Research direction
Investigate how to use pyreverse to generate class diagrams for the ContainerManager project, and explore methods to render .dot files in Markdown (e.g., using mermaid or embedding SVG). Focus on adding init .py files or adjusting path imports to ensure all modules are captured. Then document the steps in the README.
Tech stack
python
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70