-
-
Notifications
You must be signed in to change notification settings - Fork 0
Added py.typed #18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added py.typed #18
Conversation
Reviewer's GuideThis PR declares the package as typed by adding py.typed to package data, bumps the project version and Python baseline to 3.10, updates supported Python classifiers and tooling configs accordingly, refreshes pre-commit hook versions, and replaces an editor-specific rules file with a general CLAUDE project guidelines document. Flow diagram for packaging with py.typed and Python 3.10 baselineflowchart TD
A[Start development] --> B[Write code in google_docstring_parser]
B --> C[Add type hints using Python 3.10 features]
C --> D[Configure pyproject.toml\npython >= 3.10\nclassifiers updated]
D --> E[Include py.typed in\npackage data]
E --> F[Build distribution]
F --> G[Upload to package index]
subgraph Consumer_Project[Downstream project]
H[Install google-docstring-parser 0.0.9]
I[Type checker reads py.typed]
J[Full type checking enabled\nfor library usage]
end
G --> H
H --> I --> J
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds PEP 561 compliance by including a py.typed marker file, enabling type checkers to use the package's type hints. The PR also modernizes the project by dropping Python 3.9 support and updating tooling versions.
Changes:
- Added
py.typedmarker file and updated package metadata for PEP 561 compliance - Dropped Python 3.9 support, bumped minimum version to 3.10, and removed typing-extensions dependency
- Updated pre-commit hook versions (pre-commit-hooks, pyproject-fmt, ruff, mypy)
- Consolidated project guidelines into CLAUDE.md and removed .cursor/rules/custom-rule.mdc
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| google_docstring_parser/py.typed | Empty marker file for PEP 561 type hint distribution |
| pyproject.toml | Version bump to 0.0.9, Python 3.10+ requirement, py.typed in package-data, removed typing-extensions, added Python 3.14 classifier |
| CLAUDE.md | New documentation for AI assistant guidelines and project conventions |
| .pre-commit-config.yaml | Updated tool versions (v6.0.0, v2.11.1, v0.14.11, v1.19.1) |
| .cursor/rules/custom-rule.mdc | Removed in favor of CLAUDE.md |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary by Sourcery
Bump package and tooling to Python 3.10+, declare typing support, and refresh development tooling configuration.
Build:
CI:
Documentation:
Chores: