openedx / openedx/openedx-events

Add type annotations

Open
#563 4 comments 0 reactions 1 assignee View on GitHub

@bmtcril is already working on this.

Since Apr 16, 2026.

Dominant language
Python
Stars
13
Forks
33
Avg merge
14h 37m
Merged PRs (30d)
4

Description

Attempting to use this library in a project that uses mypy (e.g. openedx-core) results in a mypy error because it doesn't seem to have any type annotations:

Image 
signals.py:6: error: Skipping analyzing "openedx_events.tooling": module is installed, but missing library stubs or py.typed marker  [import-untyped]
signals.py:6: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
Found 1 error in 1 file (checked 247 source files)

To fix this:

  1. Add type annotations, and
  2. Add a py.typed marker so the annotations will get installed and used.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.