Visualization of the yfinance codebase #2541
Replies: 2 comments 1 reply
-
|
I like visuals. Onboarding chart is good.
Then you're aiming to be better than the free alternatives, to charge? I'd want to be able to zoom in and see a component expand to its contents. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the response @ValueRaider! We want to have a freemium style of payment, where OSS can have it for free for certain depth levels, like the 2 that we've generasted for you. (The diagram is clickable). As you are interested I will generated one diagram with a depth level of 3 so you can take a look <3. We are looking more on if this is something that is valuable to people, as we want to do something which is actually useful for people and then figure out monetization i.e. people with private repositories also care about privacy which will come at a cost for us and hense for them as well. |
Beta Was this translation helpful? Give feedback.
-
|
I have generated the yfianance with bigger graph depth for better explorability here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/yfinance/on_boarding.md I would love to hear what you think about it. You go in deeper levels by clicking in the diagram on the blue components |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hey all,
I'm Ivan, and together with a friend, we're working on making it easier for everyone to understand new codebases. We believe visualization is key, so we're creating diagram-first documentation. To achieve this, we use static analysis and LLMs. Here's one I generated for yfinance:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/yfinance/on_boarding.md
A smaller version (the initail one I pasted in the discussion can be found here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/yfinance_depth_2/on_boarding.md
yfinance has 2.7K forks, so there are a lot of people who interact with the codebase not only as users but also as developers. We believe that usually they want to modify just a component or two, which is of their interest. This said we think that with the diagram they can quickly navigate and understand the flow and how the component of interest integrates with the rest of the system.I would love to hear what you think on the idea, we've also just introduced a github action to keep those generations up-to-date!
If you like the diagrams I'd be more than happy to open a PR!
Any feedback is more than welcome!
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.
Beta Was this translation helpful? Give feedback.
All reactions