Add py.typed marker for type checker support

[Jagriti-student]

Adds py.typed marker file to indicate type checker support.
Packaging uses src layout, so the marker will be included in the build.

closes #14

Summary by CodeRabbit

• Documentation
  • Added CI check verification guide in README covering local setup and requirements.
  • Enhanced docstrings across core modules with detailed multi-line documentation for improved code clarity.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[continue]

Learn more

---

All Green is an AI agent that automatically:

✅ Addresses code review comments

✅ Fixes failing CI checks

✅ Resolves merge conflicts

---

Unsubscribe from All Green comments

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request performs a documentation and formatting pass across the codebase. It adds a CI verification guide to the README, converts multiple single-line module and class docstrings to multi-line triple-quoted format throughout the core modules, and removes type-checking marker comments from the py.typed marker file.

Changes

Cohort / File(s)	Summary
Documentation & Setup README.md	Added new "Running CI Checks Locally" section with prerequisites (Python 3.10+, Poetry) and setup instructions (poetry install --with dev).
Docstring Reformatting src/agentunit/adapters/base.py, src/agentunit/core/__init__.py, src/agentunit/core/exceptions.py, src/agentunit/core/replay.py, src/agentunit/core/runner.py, src/agentunit/core/scenario.py, src/agentunit/core/trace.py	Converted single-line docstrings to explicit multi-line triple-quoted format across module, class, and method definitions. No functional or behavioral changes.
Type Marker Update src/agentunit/py.typed	Removed PEP 561 type-checking marker comments from the file, leaving it empty.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Large set of highly homogeneous changes (repetitive docstring reformatting pattern applied consistently across 7+ files)
• No logic modifications, behavioral changes, or new features introduced
• README addition is straightforward documentation
• Primary consideration: verify that removing markers from py.typed does not impact type-checking workflows

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 2 inconclusive)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	The PR introduces extensive docstring reformatting across multiple files (base.py, init.py, exceptions.py, replay.py, runner.py, scenario.py, trace.py) which extends far beyond the py.typed marker objective.	Remove docstring reformatting changes unrelated to issue #14. Focus the PR solely on adding/verifying the py.typed marker file as specified in the acceptance criteria.
Description check	❓ Inconclusive	The PR description is brief but provides essential information: the purpose (py.typed marker for type checking), the reason (src layout packaging), and the linked issue. However, it deviates significantly from the template structure with minimal detail.	While the description covers the basic objective, it lacks alignment with the provided template. Consider adding sections like 'Type of Change', 'Changes Made', 'Testing', and 'Code Quality' to improve clarity and thoroughness.
Linked Issues check	❓ Inconclusive	The PR addresses the core requirement from issue #14 by adding a py.typed marker file, though the raw summary indicates the file was actually removed (emptied) rather than created as new content.	Clarify the status of the py.typed file: the summary states it was 'removed/emptied', but issue #14 requires it to exist and be included in the build. Verify the final state meets acceptance criteria.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding a py.typed marker file for type checker support, which is the core objective of the PR.
Docstring Coverage	✅ Passed	Docstring coverage is 85.71% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b85e986 and 7e21593.

📒 Files selected for processing (9)

• README.md (1 hunks)
• src/agentunit/adapters/base.py (1 hunks)
• src/agentunit/core/__init__.py (1 hunks)
• src/agentunit/core/exceptions.py (1 hunks)
• src/agentunit/core/replay.py (2 hunks)
• src/agentunit/core/runner.py (1 hunks)
• src/agentunit/core/scenario.py (4 hunks)
• src/agentunit/core/trace.py (3 hunks)
• src/agentunit/py.typed (0 hunks)

💤 Files with no reviewable changes (1)

• src/agentunit/py.typed

🧰 Additional context used

🧬 Code graph analysis (1)

src/agentunit/adapters/base.py (3)

tests/test_runner.py (1)

• execute (30-38)

src/agentunit/datasets/base.py (1)

• DatasetCase (19-27)

src/agentunit/core/trace.py (1)

• TraceLog (26-78)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Test (Python 3.10)

🔇 Additional comments (8)

src/agentunit/core/runner.py (1)

1-3: LGTM! Docstring formatting improved.

The conversion from single-line to multi-line format improves consistency with Python docstring conventions.

src/agentunit/core/scenario.py (1)

1-3: LGTM! Consistent docstring formatting improvements.

All docstrings have been properly converted to multi-line format, improving readability and consistency with Python conventions.

Also applies to: 24-26, 82-84, 100-102

src/agentunit/core/exceptions.py (1)

1-3: LGTM! Exception docstrings properly formatted.

All exception class docstrings have been consistently converted to multi-line format, improving documentation clarity.

Also applies to: 9-11, 15-17, 21-23

src/agentunit/adapters/base.py (1)

35-42: LGTM! Excellent documentation improvements for abstract methods.

The expanded docstrings now include detailed descriptions, parameters, and return types, making the adapter interface much clearer for implementers.

Also applies to: 46-55, 58-66

src/agentunit/core/trace.py (1)

1-3: LGTM! Tracing utility docstrings properly formatted.

All docstrings have been consistently converted to multi-line format, maintaining documentation clarity.

Also applies to: 16-18, 27-29

README.md (1)

206-219: LGTM! Helpful contributor documentation added.

The new section provides clear instructions for running CI checks locally, which will help contributors catch issues before opening PRs.

src/agentunit/core/replay.py (1)

1-3: LGTM! Replay utility docstrings properly formatted.

Docstrings have been consistently converted to multi-line format, improving documentation consistency.

Also applies to: 13-15

src/agentunit/core/__init__.py (1)

1-3: LGTM! Core module docstring properly formatted.

The module docstring has been converted to multi-line format, consistent with other modules in this PR.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[aviralgarg05]

LGTM!