Repository navigation
Docs/fix setup instructions - #180
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
iansargent
left a comment
There was a problem hiding this comment.
Charles,
Thank you for taking the time for edits! These changes are perfect for ensuring our documentation is updated is not going stale. We switched over to uv a while ago and the streamlit references our first prototype build of the site.
Anyways, I hope to see more PRs from you!
Happy coding,
Ian
Ian, Thanks so much for the warm welcome! I'm planning on exploring some data from The U.S. Energy Information Administration and see if I can't get it cleaned to y'all's standards as time permits. It should be a very rich source of energy, emissions, and fuel data. |
iansargent
left a comment
There was a problem hiding this comment.
Looks great! Thanks!
What was wrong
pip install -r requirements.txt: the repo has norequirements.txt. Dependencies are inbackend/pyproject.tomlanduv.lock, and the root README installs them withuv sync.streamlit run Home.py:backend/Home.pydoesn't exist, andstreamlitisn't inpyproject.tomloruv.lock.uvicorn ...had nouv runprefix. CLAUDE.md's own tip on L11 says to useuv run, and so does the justfile'slocal-apirecipe.codebase_primer.md, but the file isdocs/Codebase_Primer.md. The link works on Windows and macOS, which ignore case in file names, but gives a 404 on GitHub and Linux.What changed
Codebase_Primer.md. The file itself isn't renamed.pip install -r requirements.txtbecomesuv sync, the uvicorn command gets theuv runprefix, and the Streamlit line is removed.Docs only: 2 files, +3/−4.
How I verified it
backend/requirements.txtandbackend/Home.pydon't exist, and thatstreamlitdoesn't appear inpyproject.tomloruv.lock.requirements.txt,Home.pyandcodebase_primer(ignoring case). Nothing stale remains. README.md L5 already used the correctdocs/Codebase_Primer.md.prettier --checkwith the repo's Prettier 3.9.4:mainbecause of the table padding, a blank line and a trailing space. This PR doesn't touch those lines, so it doesn't fix them or make them worse.For maintainers to decide (not in this PR)
Codebase_Primer.mdtocodebase_primer.md. That would follow the convention at docs/README.md L18 ("File names are lowercasesnake_case.md"). The rename would also need the links in README.md L5 and docs/README.md L3 updated. I'm happy to open a follow-up PR if you want it.frontend/**/*.ts(x), so markdown isn't checked automatically. I can include that fix in the same follow-up.🤖 Generated with Claude Code