Interactive diagram representation of pysnowball #43
Closed
ivanmilevtues
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hey all I am working on an open-source tool to generate interactive diagram representations of codebases. The diagram starts from the highest level of abstraction and if you click on any of the components, there is a diagram in the same style for that component:
graph LR User_Client_Application["User/Client Application"] Pysnowball_API_Wrapper_Facade_["Pysnowball API Wrapper (Facade)"] Authentication_Configuration["Authentication & Configuration"] Request_Response_Handler["Request & Response Handler"] Data_Specific_Modules["Data Specific Modules"] External_Financial_APIs["External Financial APIs"] User_Client_Application -- "requests data from" --> Pysnowball_API_Wrapper_Facade_ Pysnowball_API_Wrapper_Facade_ -- "delegates request to" --> Data_Specific_Modules Data_Specific_Modules -- "retrieves config from" --> Authentication_Configuration Data_Specific_Modules -- "invokes request via" --> Request_Response_Handler Request_Response_Handler -- "sends requests to" --> External_Financial_APIs External_Financial_APIs -- "returns raw data to" --> Request_Response_Handler Request_Response_Handler -- "provides parsed data to" --> Data_Specific_Modules Data_Specific_Modules -- "returns processed data to" --> Pysnowball_API_Wrapper_Facade_ Pysnowball_API_Wrapper_Facade_ -- "returns data to" --> User_Client_Application click Pysnowball_API_Wrapper_Facade_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pysnowball/Pysnowball_API_Wrapper_Facade_.md" "Details" click External_Financial_APIs href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pysnowball/External_Financial_APIs.md" "Details"The generation tool is based on Static Analysis and LLMs and is fully open-source: https://github.com/CodeBoarding/CodeBoarding
You can see the full diagram here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pysnowball/on_boarding.md
Any feedback is appreciated! Would love to hear your opinion on diagrams as an exploration tooling and diagram first documentation!
Beta Was this translation helpful? Give feedback.
All reactions