Shipping PyStonks with a friend
Tl;DR
The historical stock webapp, companion for: https://financeinmotion.fyi
Intro
To pull data from yfinance should not be a secret anymore:
https://jalcocert.github.io/JAlcocerT/python-financial-data-with-yfinance/ https://jalcocert.github.io/JAlcocerT/r-yfR-package-guide/
Plus also on the initial PyStonks Post, I dedicted time for a yfinance EDA ipynb section.
On my recent pystonks version, I could see how the FastAPI version es more flexible than the PyStocks Streamlit and understandable by LLMs more than Reflex.
While playing very well with SSGs like Astro, unlike Flask or Django.
Now, Im going to take back the collaboration with my friend: btw, he is a PDH.
FAQ
How to define the scope of a Project:
- BRD: The high-level business “why” and “what.”
- PRD: The detailed product “what.”
- FRD: The technical “how.”
FRD vs User Stories 📌
You’ve hit on a key point of the shift from traditional to Agile methodologies.
Yes, in many Agile frameworks, particularly Scrum, user stories often replace the detailed Functional Requirements Document (FRD).
The Problem with the FRD in Agile
- Fixed and Detailed: The FRD is a static document that assumes all requirements can be known upfront. In Agile, the philosophy is that requirements will emerge and change over time.
- Discourages Conversation: A comprehensive FRD can lead to a “sign it and build it” mentality, where developers simply follow instructions. Agile values collaboration and communication, and a rigid document can be a barrier to that.
- Focuses on “What the System Does”: While the FRD is a great tool for technical teams, it can lose sight of the “why.” It describes system behavior (“The system shall validate the user’s credentials”) without tying it to the user’s need.
How User Stories Change the Approach
User stories shift the focus from a detailed technical specification to a high-level, user-centric description. A user story is a promise for a conversation, not a final document.
The classic format of a user story is:
As a
<type of user>, I want to<perform some action>, so that<I can achieve some goal/benefit>.
Instead of a 50-page FRD, an Agile team uses a backlog of user stories to define the work.
The Key Elements that Replace the FRD’s Detail
The detailed information that would have been in an FRD doesn’t disappear; it’s just captured differently and at a different time.
Conversation: The user story’s primary purpose is to spark a conversation between the product owner, developers, and designers. This conversation happens during sprint planning and backlog refinement, where the team discusses the “how” in detail.
Acceptance Criteria: Each user story has a set of Acceptance Criteria. These are specific conditions that must be met for the story to be considered “done.” They serve the same purpose as the FRD’s requirements—they define testable system behaviors. For example:
- User Story: “As a user, I want to be able to log in so that I can access my account.”
- Acceptance Criteria:
- GIVEN a user provides a valid email and password, WHEN they click “Log In,” THEN they are redirected to their dashboard.
- GIVEN a user provides an invalid password, WHEN they click “Log In,” THEN an error message “Invalid credentials” is displayed.
Refinement and Just-in-Time Documentation: The team doesn’t define all the technical details upfront. They are elaborated on as the story moves to the top of the backlog, right before it’s pulled into a sprint. This is often called “just-in-time” documentation.
This avoids building out detailed plans for features that may change or be de-prioritized.
In essence, user stories bring the conversation and collaboration to the forefront, allowing teams to be more flexible and responsive to change—which is the core of the Agile Manifesto.
How to Start PyStonks Project
Step 1:
Get familiar with git: https://it-tools.tech/git-memo
In this case Github, but it could have been Gitlab / Gitea similarly:
git init
git branch -m main
git config user.name
git config --global user.name "JAlcocerT"
git config --global user.name
git add .
git commit -m "Initial commit: Pystonks Cerdos project"
#sudo apt install gh
gh auth login
gh repo create py-stonks-cerdos --private --source=. --remote=origin --pushStep 2: stop copy pasting from chatgpt and use Windsurf/Cursor/whatever
Are those 20$/month more valuable than your time? Please…