Make the project more friendly to being a library
- Dominant language
- Python
- Stars
- 25
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
**What is wrong and why is it wrong**
The project can not really be used as a library currently. It is structured solely for the bot. However, it should be easy to change it so it can be used for any stock related thing. Like getting the relevant years, etc.
**Where is it wrong?**
Just everywhere
**Check List**
- [ ] Update type hints and docstrings
- [ ] Return values
- [ ] Option to not download the heavy `Stocks` Folder
- [ ] Add a read the docs
- [ ] Update Readme
- [ ] Add tests
- [ ] Finish Alpha version project
- [ ] Add a way to pip install
- [x] Update requirements.txt
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by inspecting the project structure and the current requirements.txt, then identify how the bot currently exposes stock-related functionality. The checklist names type hints, docstrings, return values, optional Stocks-folder downloads, Read the Docs, README, tests, and pip installation as required areas. Done means the project can be used as a general library, with tests and installation/documentation support in place.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100