discussion: Roadmap for this project

[marc-at-brightnight]

I would like to see how I can contribute on this repo. It seems like the repo has good fundamentals. However, it would be helpful to understand your vision (@virattt), so the dev community can focus their efforts. From this issue, I gather other people want to be involved but not sure where to start.

In my mind, here's some things that could be improved. Note some items are more speculative, open to pushback.

chores 🔄

• Add pydantic models as interfaces between functions (or dataclasses where validation is not needed)
• Type the whole repo using 3.9+ standards (no List/Dict/Union/Optional)
• Add linting (ruff?)
• cicd - linting, black, mypy
• python semantic release in cicd - automatic versioning and changelog
• Testing - I realize this is a tricky one. Due to the nature of LLM's, there is a cost element. Initially, we could have a series of tests that contributors can run locally to make sure there are no regressions or bugs added. Long term, we support open source models that can run in cicd

features 🚀

• Add yfinance app for free tier - This has been a popular user request. After we add pydantic models for the API, it should be easy to plug and play other APIs
• Support crypto - Longer term item and not sure of scope, but I certainly think it would be cool
• Take input for risk tolerance - Informs the model how aggressive its recommendations should be
• ...what else?

I started with this PR, which adds pydantic models for the outputs.

[virattt]

Thanks @marc-at-brightnight

Could definitely use some help with the chores and standardizing the code style!