Skip to content

feat: add py.typed marker for PEP 561 compliance#400

Merged
cebtenzzre merged 1 commit intonomic-ai:mainfrom
yashwantbezawada:add-py-typed-marker
Nov 4, 2025
Merged

feat: add py.typed marker for PEP 561 compliance#400
cebtenzzre merged 1 commit intonomic-ai:mainfrom
yashwantbezawada:add-py-typed-marker

Conversation

@yashwantbezawada
Copy link
Copy Markdown
Contributor

@yashwantbezawada yashwantbezawada commented Nov 4, 2025

Fixes #312

Summary

Adds a py.typed marker file to enable type checking support for downstream projects using mypy, pyright, or other type checkers that follow PEP 561.

Changes

  • Added empty py.typed file in the nomic package directory
  • Added MANIFEST.in to ensure the marker file is included in distributions

Context

The nomic package already has comprehensive type annotations throughout the codebase. Adding the py.typed marker allows type checkers in downstream projects to recognize and use these annotations, improving the development experience for users of the library.

This follows the PEP 561 specification for distributing type information: https://typing.readthedocs.io/en/latest/spec/distributing.html#packaging-type-information


Important

Adds py.typed marker for PEP 561 compliance, enabling type checking in downstream projects.

  • Type Checking:
    • Adds py.typed file to nomic package for PEP 561 compliance, enabling type checking for downstream projects.
    • Creates MANIFEST.in to include py.typed in distributions.

This description was created by Ellipsis for cff32e4. You can customize this summary. It will automatically update as commits are pushed.

Adds a py.typed marker file to enable type checking in downstream
projects that use mypy or other type checkers. This allows static
type checkers to recognize and use the type annotations present in
the nomic package.

Also adds MANIFEST.in to ensure the py.typed file is included in
the distributed package.

Resolves nomic-ai#312
Copy link
Copy Markdown
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

Looks good to me! 👍

Reviewed everything up to cff32e4 in 31 seconds. Click for details.
  • Reviewed 10 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. MANIFEST.in:1
  • Draft comment:
    MANIFEST.in correctly includes the py.typed file for PEP 561 compliance. This change meets the issue requirements.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 70% None

Workflow ID: wflow_aQvDdZqGGwtM9Sfm

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

Copy link
Copy Markdown
Member

@cebtenzzre cebtenzzre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, this should be a net improvement.

@cebtenzzre cebtenzzre merged commit 762aeee into nomic-ai:main Nov 4, 2025
@cebtenzzre
Copy link
Copy Markdown
Member

Thanks for the PR!

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.

Feature: Add a py.typed file to support type checking in downstream code

2 participants