From efb595d6245248e84e209b5b6f2e0687ddd037a9 Mon Sep 17 00:00:00 2001 From: Rohan McGovern Date: Mon, 18 Sep 2023 13:25:42 +1000 Subject: [PATCH] Add py.typed for PEP 561 This library includes inline type hints, but per PEP 561 this must be indicated by including a "py.typed" marker file, otherwise tools like mypy will not make use of the type hints when checking downstream projects. --- README.md | 4 ++++ docs/conf.py | 2 +- pyproject.toml | 2 +- repo_autoindex/py.typed | 0 4 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 repo_autoindex/py.typed diff --git a/README.md b/README.md index 68ca3d8..07d1c9d 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,10 @@ information about the usage of `repo-autoindex`. ## Changelog +### v1.1.2 - 2023-09-18 + +- Add `py.typed` to make package PEP 561 compliant / enable downstream type-checking. + ### v1.1.1 - 2023-04-12 - Fix handling of kickstart repositories with no checksums in treeinfo. diff --git a/docs/conf.py b/docs/conf.py index fe5a9b3..d37286f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,7 +9,7 @@ project = "repo-autoindex" copyright = "2023, Red Hat" author = "Rohan McGovern " -release = "1.1.1" +release = "1.1.2" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/pyproject.toml b/pyproject.toml index 16ed525..8fc46cf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "repo-autoindex" -version = "1.1.1" +version = "1.1.2" description = "Generic static HTML indexes of various repository types" authors = ["Rohan McGovern "] license = "GPL-3.0-or-later" diff --git a/repo_autoindex/py.typed b/repo_autoindex/py.typed new file mode 100644 index 0000000..e69de29