How jsoconno/architectures works
File Structure
• Top-level components:
– .github/workflows: CI/CD definitions (tests, coverage, pip-publish)
– core library:
• architectures/core → Graph, Cluster, Node, Edge, Flow logic
• architectures/providers → service-specific Node subclasses
• architectures/themes → styling presets
• assets, examples, scripts, tests
– setup.py, MANIFEST.in, README.md for packaging
• Scripts: convert.py, generate_providers.py, get_latest_release → auxiliary automation
• Examples and tests show usage and validate behavior.
README for Insights
• Core Components: Graph, Cluster, Node, Edge, Flow
• Themes: Default, LightMode, DarkMode
• Providers: classes mapping to real-world cloud services
• Workflow: user code → instantiate Graph → add provider Nodes → render via Graphviz
Main Components and Their Relationships
• User Environment (Python interpreter, Graphviz engine)
• Package Distribution (PyPI)
• CI/CD Pipeline (GitHub Actions → tests → codecov → publish)
• Source Code Cluster:
– Core Module
– Provider Modules
– Theme Module
• Examples & Scripts cluster
• Test Suite cluster
Interactions:
• Themes layer styling attributes onto core objects.
• Examples import core+providers+themes to demonstrate usage.
• CI/CD orchestrates testing and publishing to PyPI.
Architectural Patterns and Principles
• “Provider” pattern: each cloud service is a subclass of Node
• Code-generation scripts maintain provider lists and assets
• CI/CD as code (.github/workflows) for test and release automation
• Package as library and CLI scripts for local use
Elements
• Clear labels on each cluster and component
– Source code → Python interpreter → Graphviz engine
– CI/CD pipeline reads source, runs tests, publishes to PyPI
– Examples/scripts import core, providers, themes