feat: adds mypy type checking

.github/workflows/build.yml

@@ -11,20 +11,16 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Install Dependencies
         run: make install
-      - name: Run linting
-        run: make lint
       - name: Check format
         run: make format-check
-      - name: Check imports
-        run: make isort-check
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        pythonversion: ["3.7", "3.8", "3.9"]
+        pythonversion: ["3.7", "3.8", "3.9", "3.10"]
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Install pypa/build
         run: >-
           python -m

CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v1.7.0 (2021-11-29)
+
+* Adds `mypy` and type hinting via `py.typed`
+* Simplifies template module (removes unused class)
+* Adds missing `__all__` variable to `__init__.py`
+* Simplifies the lint step of the build by only running checks once (previously some checks were getting run twice)
+* Tests against Python `3.10`
+
 ## v1.6.0 (2021-10-08)
 
 * Adds `Black` and `iSort` as dev dependencies

Makefile

@@ -31,10 +31,10 @@ black-check:
 	$(VIRTUAL_BIN)/black $(PROJECT_NAME)/ test/ --check
 
 ## format - Runs all formatting tools against the project
-format: black isort lint
+format: black isort lint mypy
 
 ## format-check - Checks if the project is formatted correctly against all formatting rules
-format-check: black-check isort-check lint
+format-check: black-check isort-check lint mypy
 
 ## install - Install the project locally
 install:
@@ -54,6 +54,10 @@ isort-check:
 lint:
 	$(VIRTUAL_BIN)/flake8 $(PROJECT_NAME)/ test/
 
+## mypy - Run mypy type checking on the project
+mypy:
+	$(VIRTUAL_BIN)/mypy $(PROJECT_NAME)/ test/
+
 ## test - Test the project
 test:
 	$(VIRTUAL_BIN)/pytest

project_name/__init__.py

@@ -1,2 +1,5 @@
-# flake8: noqa
-from project_name.my_module import MyModule
+from project_name.my_module import main
+
+__all__ = [
+    'main',
+]

project_name/my_module.py

@@ -1,11 +1,6 @@
-class MyModule:
-    def my_function():
-        pass
-
-
 def main():
     """The main entrypoint for this script used in the setup.py file."""
-    MyModule.my_function()
+    pass
 
 
 if __name__ == '__main__':

setup.py

@@ -13,6 +13,7 @@
     'coveralls == 3.*',
     'flake8',
     'isort',
+    'mypy',
     'pytest == 6.*',
     'pytest-cov == 2.*',
 ]
@@ -27,6 +28,7 @@
     author='USERNAME',
     license='MIT',
     packages=setuptools.find_packages(),
+    package_data={'PROJECT_NAME_URL': ['py.typed']},
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",

test/unit/test_my_module.py

@@ -1,13 +1,5 @@
-from unittest.mock import patch
+import project_name
 
-from project_name.my_module import MyModule, main
 
-
-def test_my_function():
-    MyModule.my_function()
-
-
-@patch('project_name.my_module.MyModule.my_function')
-def test_main(mock_my_function):
-    main()
-    mock_my_function.assert_called_once()
+def test_main():
+    project_name.main()