Make mypy optional + add py.typed

src/scicookie/hooks/post_gen_project.py

@@ -31,6 +31,7 @@
 USE_CONTAINERS = {{ cookiecutter.use_containers in ['Docker', 'Podman'] }}
 USE_CLI = {{ cookiecutter.command_line_interface != "No command-line interface" }}
 USE_CONDA = {{ cookiecutter.use_conda == "yes" }}
+USE_MYPY = {{ cookiecutter.use_mypy == "yes" }}
 {% if cookiecutter.code_of_conduct == "contributor-covenant" -%}
 COC_PATH = PROJECT_DIRECTORY / 'coc' / 'CONTRIBUTOR_COVENANT.md'
 {%- elif cookiecutter.code_of_conduct == "citizen-code-of-conduct" -%}
@@ -96,6 +97,7 @@ def move_selected_doc_dir():
 
     shutil.rmtree(DOCS_SPEC_DIR)
 
+
 def clean_up_docs():
     remove_dirs(UNUSED_DOCS_DIRS)
     move_selected_doc_dir()
@@ -194,6 +196,7 @@ def clean_up_build_system():
         )
     remove_dir("build-system")
 
+
 def http2ssh(url):
     url = url.replace("https://", "git@")
     return url.replace("/", ":", 1)
@@ -241,13 +244,18 @@ def prepare_git():
     print("=" * 80)
 
 
+def clean_up_mypy():
+    if not USE_MYPY: remove_package_file("py.typed")
+
+
 def post_gen():
     validation()
 
     # keep this one first, because it changes the package folder
     clean_up_project_layout()
 
     clean_up_cli()
+    clean_up_mypy()
     clean_up_code_of_conduct()
     clean_up_conda()
     clean_up_containers()

src/scicookie/profiles/base.yaml

@@ -123,6 +123,7 @@ use_tools:
     - ruff
     - isort
     - mccabe
+    - mypy
     - pre-commit
     - pydocstyle
     - pytest

src/scicookie/{{cookiecutter.project_slug}}/{{cookiecutter.package_slug}}/__init__.py

@@ -10,16 +10,16 @@
 from importlib import metadata as importlib_metadata
 
 
-def get_version() -> str:
+def get_version():
     """Return the program version."""
     try:
         return importlib_metadata.version(__name__)
     except importlib_metadata.PackageNotFoundError:  # pragma: no cover
         return {{ QUOTE }}{{ cookiecutter.project_version }}{{ QUOTE }}  # semantic-release
 
 
-version: str = get_version()
+version = get_version()
 
 __author__ = {{ QUOTE }}{{ cookiecutter.author_full_name }}{{ QUOTE }}
 __email__ = {{ QUOTE }}{{ cookiecutter.author_email }}{{ QUOTE }}
-__version__: str = version
+__version__ = version