docs: add architecture CLAUDE.md for coding agents#47
Merged
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MFxhjNFjkpnw36P9bizdHR
EarningsCall
force-pushed
the
docs/claude-md-architecture
branch
from
July 21, 2026 14:23
5fddb5c to
31e1cd0
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds ChangesRepository Documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a CLAUDE.md documenting the SDK: public surface and key modules, the HTTP/auth layer (
v2.api.earningscall.biz, apikey resolution), and the release flow (Hatch, trusted publishing onv*tags — points to DEVELOPMENT.md for details). Verified gotchas: thehatch_initreferences in pyproject.toml are dead template config (bump[project] versioninstead of creating that package), and stale-state traps from module-level singletons plus the default-on requests-cache.Docs only — no code changes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01MFxhjNFjkpnw36P9bizdHR
Note
Low Risk
Documentation-only change with no runtime or API behavior impact.
Overview
Adds
CLAUDE.mdat the repo root as onboarding documentation for AI coding agents (and humans) working on theearningscallPyPI SDK.It documents the public API surface, how HTTP/auth works (
v2.api.earningscall.biz, api key resolution and demo limits), a map of key modules (api.py,company.py,symbols.py, tests/fixtures), and shipping (Hatch/CI and release via version bump +v*tag to PyPI). A Gotchas section calls out deadhatch_initconfig inpyproject.tomland stale state from module singletons and the default requests cache.Reviewed by Cursor Bugbot for commit 31e1cd0. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit