feat: add PEP-561 py.typed file for downstream type checkers (#440)

* feat: add PEP-561 py.typed file for downstream type checkers This follows PEP-561 to mark syrupy as compatible with type checking (driven by the type annotations that already exist and are checked), by creating an empty `py.typed` in the project. This stops users from having to ignore syrupy when type checking, and allows the type checker to provide specific guidance about possible problems. Fixes #439
syrupy-project · Dec 1, 2020 · fe15bdb · fe15bdb
1 parent 620fb4a
commit fe15bdb
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 0 deletions.
diff --git a/setup.py b/setup.py
@@ -64,6 +64,7 @@ def readme() -> str:
             "write_to": "version.txt",
         },
         package_dir={"": "src"},
+        package_data={"": ["py.typed"]},
         packages=find_packages("./src"),
         zip_safe=False,
         entry_points={"pytest11": ["syrupy = syrupy"]},

diff --git a/src/syrupy/py.typed b/src/syrupy/py.typed