Skip to content
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

Feature: Add package typing marker #156

Merged
merged 3 commits into from
Aug 22, 2024
Merged

Conversation

JakobEliasWagner
Copy link
Collaborator

@JakobEliasWagner JakobEliasWagner commented Aug 20, 2024

Feature: Add package typing marker

Description

This pr introduces support for PEP 561 to allow downstream users to leverage type hints in our library. By making this change, we provide the necessary metadata for tools like mypy to recognize and validate type hints.

Which issue does this PR tackle?

  • Continuiti currently does not provide type information.

How does it solve the problem?

  • Adds py.typed file that signals that Continuiti includes type information.
  • Adds py.typed to the package data to ensure it is included in the package distribution.

How are the changes tested?

  • All tests run without new errors.

Checklist for Contributors

  • Scope: This PR tackles exactly one problem.
  • Conventions: The branch follows the feature/title-slug convention.
  • Conventions: The PR title follows the Bugfix: Title convention.
  • Coding style: The code passes all pre-commit hooks.
  • Documentation: All changes are well-documented.
  • Tests: New features are tested and all tests pass successfully.
  • Changelog: Updated CHANGELOG.md for new features or breaking changes.
  • Review: A suitable reviewer has been assigned.

Checklist for Reviewers:

  • The PR solves the issue it claims to solve and only this one.
  • Changes are tested sufficiently and all tests pass.
  • Documentation is complete and well-written.
  • Changelog has been updated, if necessary.

@JakobEliasWagner JakobEliasWagner self-assigned this Aug 20, 2024
@JakobEliasWagner JakobEliasWagner added the enhancement New feature or request label Aug 20, 2024
@samuelburbulla samuelburbulla force-pushed the feature/support-typing branch from 4100ef9 to c17e419 Compare August 22, 2024 09:04
@samuelburbulla samuelburbulla merged commit 74e1687 into main Aug 22, 2024
14 checks passed
@samuelburbulla samuelburbulla deleted the feature/support-typing branch August 22, 2024 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants