Skip to content

feat: add py.typed file#47

Merged
olivermeyer merged 1 commit intomainfrom
feat/add-py-typed
Apr 13, 2026
Merged

feat: add py.typed file#47
olivermeyer merged 1 commit intomainfrom
feat/add-py-typed

Conversation

@olivermeyer
Copy link
Copy Markdown
Collaborator

This allows type checkers to work with the library.

@olivermeyer olivermeyer requested a review from a team as a code owner April 13, 2026 14:41
@olivermeyer olivermeyer added the claude Trigger Claude Code automation label Apr 13, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.
see 1 file with indirect coverage changes

@claude
Copy link
Copy Markdown

claude bot commented Apr 13, 2026

Claude finished @olivermeyer's task in 2m 3s —— View job


Code Review Complete

I've thoroughly reviewed PR #47 for adding PEP 561 type checking support via py.typed. Here are my findings:


✅ What's Good

  1. Correct Implementation: The py.typed file is correctly placed at src/aignostics_foundry_core/py.typed and is empty, which is the standard PEP 561 approach.

  2. Existing Type Annotations: The codebase has comprehensive type hints throughout (verified in console.py, service.py, and other modules).

  3. Classifier Already Present: The "Typing :: Typed" classifier is already in pyproject.toml:45, which is great.

  4. Package Inclusion: The hatchling configuration include = ["src/*"] will automatically include the py.typed file in the wheel distribution.

  5. Commit Message: "feat: add py.typed file" follows conventional commits correctly.

  6. CI Passing: All quality gates passed (SonarQube, Codecov).


🚨 Blocking Issues

Version Rollback Conflict

Location: Multiple files (VERSION, pyproject.toml, sonar-project.properties, CHANGELOG.md, uv.lock)

Issue: This PR branch is based on commit 04d2e5e (before the 0.11.1 release), but main is now at 4f83f9c (version 0.11.1). The diff shows:

- version = "0.11.1"
+ version = "0.11.0"

This will revert the version from 0.11.1 back to 0.11.0 and remove the 0.11.1 changelog entry when merged.

Fix Required: Rebase this branch on top of current main:

git fetch origin main
git rebase origin/main
git push --force-with-lease

After rebasing, the only change should be the addition of src/aignostics_foundry_core/py.typed.


💡 Suggestions

Documentation Update

While not blocking, consider documenting this feature:

README.md could mention type checking support:

## Type Checking

This package includes full type annotations and a `py.typed` marker file for PEP 561 compliance. Type checkers like mypy and pyright can verify usage of this library.

Or in the relevant section of FOUNDRY_README.md under tooling/development.


Summary

The py.typed implementation itself is perfect. However, the branch needs to be rebased on current main to avoid reverting version 0.11.1. Once rebased, this PR will be ready to merge.

Recommendation: Rebase and force-push, then re-run CI to confirm.


@sonarqubecloud
Copy link
Copy Markdown

@olivermeyer olivermeyer merged commit 05b27fc into main Apr 13, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

claude Trigger Claude Code automation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant