install and config lint, pytest, mypy

Author: nvo87

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+ignore = E501, E265, F811, PT001, DJ05, SIM113, SIM102, AAA01
+max-line-length = 160
+exclude =
+      .git,
+      __pycache__

Makefile

@@ -0,0 +1,6 @@
+lint:
+	flake8 src
+	mypy src
+
+test:
+	cd src && pytest

requirements.in

@@ -1,5 +1,9 @@
 fastapi[all]
 pytest
 pip-tools
+
 pytest-httpx
 pytest-mock
+pytest-env
+flake8
+mypy

requirements.txt

@@ -29,6 +29,8 @@ exceptiongroup==1.0.4
     # via pytest
 fastapi[all]==0.87.0
     # via -r requirements.in
+flake8==6.0.0
+    # via -r requirements.in
 h11==0.14.0
     # via
     #   httpcore
@@ -54,6 +56,12 @@ jinja2==3.1.2
     # via fastapi
 markupsafe==2.1.1
     # via jinja2
+mccabe==0.7.0
+    # via flake8
+mypy==0.991
+    # via -r requirements.in
+mypy-extensions==0.4.3
+    # via mypy
 orjson==3.8.2
     # via fastapi
 packaging==21.3
@@ -66,15 +74,22 @@ pip-tools==6.10.0
     # via -r requirements.in
 pluggy==1.0.0
     # via pytest
+pycodestyle==2.10.0
+    # via flake8
 pydantic==1.10.2
     # via fastapi
+pyflakes==3.0.1
+    # via flake8
 pyparsing==3.0.9
     # via packaging
 pytest==7.2.0
     # via
     #   -r requirements.in
+    #   pytest-env
     #   pytest-httpx
     #   pytest-mock
+pytest-env==0.8.1
+    # via -r requirements.in
 pytest-httpx==0.21.2
     # via -r requirements.in
 pytest-mock==3.10.0
@@ -101,10 +116,13 @@ starlette==0.21.0
 tomli==2.0.1
     # via
     #   build
+    #   mypy
     #   pep517
     #   pytest
 typing-extensions==4.4.0
-    # via pydantic
+    # via
+    #   mypy
+    #   pydantic
 ujson==5.5.0
     # via fastapi
 uvicorn[standard]==0.20.0

src/basecamp/campfire_bot.py

@@ -1,7 +1,7 @@
 import httpx
 from httpx._models import Response
 
-from config import get_settings
+from src.config import get_settings
 
 settings = get_settings()
 

src/basecamp/tests/test_campfire_bot.py

@@ -1,6 +1,6 @@
 import pytest
 
-from basecamp.campfire_bot import CampfireBot
+from src.basecamp.campfire_bot import CampfireBot
 from httpx._exceptions import HTTPStatusError
 
 

src/config.py

@@ -1,12 +1,13 @@
 import os
-from distutils.util import strtobool
 from functools import lru_cache
 
 from pydantic import BaseSettings
 
+from src.helpers import str_to_bool
+
 
 class Settings(BaseSettings):
-    DEBUG: bool = bool(strtobool(os.getenv('DEBUG', 'False')))
+    DEBUG: bool = bool(str_to_bool(os.getenv('DEBUG', 'False')))
 
     BASECAMP_ACCOUNT_ID: str = 'bc-acc-id'
     BASECAMP_CHATBOT_KEY: str = 'bc-bot-key'
@@ -18,5 +19,5 @@ class Config:
 
 
 @lru_cache()
-def get_settings():
+def get_settings() -> Settings:
     return Settings()

src/conftest.py

@@ -0,0 +1,32 @@
+def str_to_bool(val: str) -> bool:
+    """
+    Convert a string representation of truth to true (1) or false (0).
+
+    distutils.strtobool is deprecated in python 3.10.
+
+    >>> str_to_bool('true')
+    True
+    >>> str_to_bool('On')
+    True
+    >>> str_to_bool('1')
+    True
+
+    >>> str_to_bool('false')
+    False
+    >>> str_to_bool('Off')
+    False
+    >>> str_to_bool('0')
+    False
+    >>> str_to_bool('xyz')
+    Traceback (most recent call last):
+        ...
+    ValueError: invalid truth value 'xyz'
+
+    """
+    val = val.lower()
+    if val in ('y', 'yes', 't', 'true', 'on', '1'):
+        return True
+    elif val in ('n', 'no', 'f', 'false', 'off', '0'):
+        return False
+    else:
+        raise ValueError("invalid truth value %r" % (val,))

src/helpers.py

@@ -1,7 +1,7 @@
 from fastapi import FastAPI
 
-from config import get_settings
-from sentry.api import api_router
+from src.config import get_settings
+from src.sentry.api import api_router
 
 
 settings = get_settings()