Skip to content

docs: add architecture CLAUDE.md for coding agents#47

Merged
EarningsCall merged 1 commit into
masterfrom
docs/claude-md-architecture
Jul 21, 2026
Merged

docs: add architecture CLAUDE.md for coding agents#47
EarningsCall merged 1 commit into
masterfrom
docs/claude-md-architecture

Conversation

@EarningsCall

@EarningsCall EarningsCall commented Jul 21, 2026

Copy link
Copy Markdown
Owner

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 on v* tags — points to DEVELOPMENT.md for details). Verified gotchas: the hatch_init references in pyproject.toml are dead template config (bump [project] version instead 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.md at the repo root as onboarding documentation for AI coding agents (and humans) working on the earningscall PyPI 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 dead hatch_init config in pyproject.toml and 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

  • Documentation
    • Added repository guidance covering the SDK’s purpose, key functionality, testing practices, release process, and operational considerations.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MFxhjNFjkpnw36P9bizdHR
@EarningsCall
EarningsCall force-pushed the docs/claude-md-architecture branch from 5fddb5c to 31e1cd0 Compare July 21, 2026 14:23
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5bf97be1-e455-4f48-9fe6-382103f5280c

📥 Commits

Reviewing files that changed from the base of the PR and between de248f0 and 31e1cd0.

📒 Files selected for processing (1)
  • CLAUDE.md

📝 Walkthrough

Walkthrough

Adds CLAUDE.md documentation for the SDK architecture, module responsibilities, release process, CI workflows, and testing state considerations.

Changes

Repository Documentation

Layer / File(s) Summary
SDK repository guide
CLAUDE.md
Documents the SDK scope, API and caching flow, major modules, release procedures, CI and publishing workflows, and testing gotchas involving module singletons and persisted cache state.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation-only addition of CLAUDE.md for coding agents.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/claude-md-architecture

Comment @coderabbitai help to get the list of available commands.

@EarningsCall
EarningsCall merged commit 5c18414 into master Jul 21, 2026
11 checks passed
@EarningsCall
EarningsCall deleted the docs/claude-md-architecture branch July 21, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant