Bumped Python version to 3.10; bumped dependencies.

Author: toddbirchard

Diff for: Makefile

@@ -1,71 +1,91 @@
-SRCPATH := $(shell pwd)
-PROJECTNAME := $(shell basename $(CURDIR))
-ENTRYPOINT := $(PROJECTNAME).ini
+PROJECT_NAME := $(shell basename $CURDIR)
+VIRTUAL_ENV := $(CURDIR)/.venv
+LOCAL_PYTHON := $(VIRTUAL_ENV)/bin/python3
 
 define HELP
-Manage $(PROJECTNAME). Usage:
-
-make run        - Run $(PROJECTNAME).
-make deploy     - Pull latest build and deploy to production.
-make update     - Update pip dependencies via Python Poetry.
-make format     - Format code with Python's `Black` library.
-make lint       - Check code formatting with flake8
-make clean      - Remove cached files and lock files.
-endef
-export HELP
-
+Manage $(PROJECT_NAME). Usage:
 
-.PHONY: run restart deploy update format lint clean help
+make run        - Run $(PROJECT_NAME) locally.
+make install    - Create local virtualenv & install dependencies.
+make deploy     - Set up project & run locally.
+make update     - Update dependencies via Poetry and output resulting `requirements.txt`.
+make format     - Run Python code formatter & sort dependencies.
+make lint       - Check code formatting with flake8.
+make clean      - Remove extraneous compiled files, caches, logs, etc.
 
-requirements: .requirements.txt
-env: ./.venv/bin/activate
+endef
+export HELP
 
-.requirements.txt: requirements.txt
-	$(shell . .venv/bin/activate && pip install -r requirements.txt)
 
+.PHONY: run install deploy update format lint clean help
 
 all help:
 	@echo "$$HELP"
 
+env: $(VIRTUAL_ENV)
+
+$(VIRTUAL_ENV):
+	if [ ! -d $(VIRTUAL_ENV) ]; then \
+		echo "Creating Python virtual env in \`${VIRTUAL_ENV}\`"; \
+		python3 -m venv $(VIRTUAL_ENV); \
+	fi
+
+.PHONY: dev
+dev: env
+	$(LOCAL_PYTHON) -m main --reload
 
 .PHONY: run
 run: env
-	python main.py
+	  $(LOCAL_PYTHON) -m main
 
+.PHONY: install
+install: env
+	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel && \
+	$(LOCAL_PYTHON) -m pip install -r requirements.txt && \
+	echo Installed dependencies in \`${VIRTUAL_ENV}\`;
 
 .PHONY: deploy
 deploy:
-	make clean
-	$(shell . ./deploy.sh)
+	make install && \
+	make run
 
+.PHONY: test
+test: env
+	$(LOCAL_PYTHON) -m \
+		coverage run -m pytest -vv \
+		--disable-pytest-warnings && \
+		coverage html --title='Coverage Report' -d .reports && \
+		open .reports/index.html
 
 .PHONY: update
 update: env
-	.venv/bin/python3 -m pip install --upgrade pip setuptools wheel
-	poetry update
-	poetry export -f requirements.txt --output requirements.txt --without-hashes
-
+	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel && \
+	poetry update && \
+	poetry export -f requirements.txt --output requirements.txt --without-hashes && \
+	echo Installed dependencies in \`${VIRTUAL_ENV}\`;
 
 .PHONY: format
 format: env
-	$(shell . .venv/bin/activate && isort ./)
-	$(shell . .venv/bin/activate && black ./)
-
+	$(LOCAL_PYTHON) -m isort --multi-line=3 . && \
+	$(LOCAL_PYTHON) -m black .
 
 .PHONY: lint
-lint:
-	flake8 . --count \
+lint: env
+	$(LOCAL_PYTHON) -m flake8 . --count \
 			--select=E9,F63,F7,F82 \
-			--exclude .git,.github,__pycache__,.pytest_cache,.venv,logs,creds,.venv,docs,logs \
+			--exclude .git,.github,__pycache__,.pytest_cache,.venv,logs,creds,.venv,docs,logs,.reports \
 			--show-source \
 			--statistics
 
-
 .PHONY: clean
 clean:
-	find . -name '*.pyc' -delete
-	find . -name '__pycache__' -delete
-	find . -name 'poetry.lock' -delete
-	find . -name 'Pipefile.lock' -delete
-	find . -name 'logs/*' -delete
-	find . -name '.pytest_cache' -delete
+	find . -name 'poetry.lock' -delete && \
+	find . -name '.coverage' -delete && \
+	find . -name '.Pipfile.lock' -delete && \
+	find . -wholename '**/*.pyc' -delete && \
+	find . -type d -wholename '__pycache__' -exec rm -rf {} + && \
+	find . -type d -wholename './.venv' -exec rm -rf {} + && \
+	find . -type d -wholename '.pytest_cache' -exec rm -rf {} + && \
+	find . -type d -wholename '**/.pytest_cache' -exec rm -rf {} + && \
+	find . -type d -wholename './logs/*.log' -exec rm -rf {} + && \
+	find . -type d -wholename './.reports/*' -exec rm -rf {} +

Diff for: database/__init__.py

@@ -1 +1 @@
-from .connect import engine, session
+from .db import engine, session

Diff for: database/connect.py renamed to database/db.py

@@ -1,4 +1,4 @@
 [mypy]
-python_version = 3.8
+python_version = 3.10
 warn_return_any = True
 warn_unused_configs = True

Diff for: deploy.sh

@@ -18,19 +18,17 @@ keywords = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.10, <4.0"
 sqlalchemy = "*"
 pymysql = "*"
 python-dotenv = "*"
-loguru = "^0.5.3"
-
-[tool.poetry.dev-dependencies]
+loguru = "*"
 pytest = "*"
 mock = "*"
 mypy = "*"
-black = "^20.8b1"
-isort = "^5.6.4"
-flake8 = "^3.8.4"
+black = "*"
+isort = "*"
+flake8 = "*"
 
 [tool.poetry.scripts]
 run = "main:init_script"

Diff for: mypy.ini

@@ -1,7 +1,26 @@
-colorama==0.4.4; python_version >= "3.5" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.5" and python_full_version >= "3.5.0"
-greenlet==1.0.0; python_version >= "3" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3"
-loguru==0.5.3; python_version >= "3.5"
-pymysql==1.0.2; python_version >= "3.6"
-python-dotenv==0.16.0
-sqlalchemy==1.4.3; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.6.0")
-win32-setctime==1.0.3; sys_platform == "win32" and python_version >= "3.5"
+black==23.7.0 ; python_version >= "3.10" and python_version < "4.0"
+click==8.1.7 ; python_version >= "3.10" and python_version < "4.0"
+colorama==0.4.6 ; python_version >= "3.10" and python_version < "4.0" and (sys_platform == "win32" or platform_system == "Windows")
+exceptiongroup==1.1.3 ; python_version >= "3.10" and python_version < "3.11"
+flake8==6.1.0 ; python_version >= "3.10" and python_version < "4.0"
+greenlet==2.0.2 ; python_version >= "3.10" and python_version < "4.0" and (platform_machine == "aarch64" or platform_machine == "ppc64le" or platform_machine == "x86_64" or platform_machine == "amd64" or platform_machine == "AMD64" or platform_machine == "win32" or platform_machine == "WIN32")
+iniconfig==2.0.0 ; python_version >= "3.10" and python_version < "4.0"
+isort==5.12.0 ; python_version >= "3.10" and python_version < "4.0"
+loguru==0.7.0 ; python_version >= "3.10" and python_version < "4.0"
+mccabe==0.7.0 ; python_version >= "3.10" and python_version < "4.0"
+mock==5.1.0 ; python_version >= "3.10" and python_version < "4.0"
+mypy-extensions==1.0.0 ; python_version >= "3.10" and python_version < "4.0"
+mypy==1.5.1 ; python_version >= "3.10" and python_version < "4.0"
+packaging==23.1 ; python_version >= "3.10" and python_version < "4.0"
+pathspec==0.11.2 ; python_version >= "3.10" and python_version < "4.0"
+platformdirs==3.10.0 ; python_version >= "3.10" and python_version < "4.0"
+pluggy==1.3.0 ; python_version >= "3.10" and python_version < "4.0"
+pycodestyle==2.11.0 ; python_version >= "3.10" and python_version < "4.0"
+pyflakes==3.1.0 ; python_version >= "3.10" and python_version < "4.0"
+pymysql==1.1.0 ; python_version >= "3.10" and python_version < "4.0"
+pytest==7.4.0 ; python_version >= "3.10" and python_version < "4.0"
+python-dotenv==1.0.0 ; python_version >= "3.10" and python_version < "4.0"
+sqlalchemy==2.0.20 ; python_version >= "3.10" and python_version < "4.0"
+tomli==2.0.1 ; python_version >= "3.10" and python_version < "3.11"
+typing-extensions==4.7.1 ; python_version >= "3.10" and python_version < "4.0"
+win32-setctime==1.1.0 ; python_version >= "3.10" and python_version < "4.0" and sys_platform == "win32"

Diff for: poetry.lock

@@ -7,6 +7,7 @@
 
 
 def cleanup_data():
+    """Purge test database of all data."""
     try:
         session.execute(text("SET FOREIGN_KEY_CHECKS=0;"))
         session.commit()
@@ -20,8 +21,9 @@ def cleanup_data():
         session.commit()
         LOGGER.success("Successfully reset all data.")
     except IntegrityError as e:
-        LOGGER.error(e.orig)
-        raise e.orig
+        LOGGER.error(f"Integrity error when resetting data: {e}")
     except SQLAlchemyError as e:
+        LOGGER.error(f"SQLAlchemyError error when resetting data: {e}")
+    except Exception as e:
         LOGGER.error(f"Unexpected error when resetting data: {e}")
-        raise e
+

Diff for: pyproject.toml

@@ -1,3 +1,4 @@
+"""Create and delete SQL records using SQLAlchemy's ORM."""
 from database import session
 from sqlalchemy_tutorial.part2_orm.models import User
 

Diff for: requirements.txt

@@ -27,7 +27,7 @@ class User(Base):
     updated_at = Column(DateTime, onupdate=func.now())
 
     def __repr__(self):
-        return "<User %r>" % self.username
+        return f"<User id={self.id}, username={self.username}, email={self.email}>"
 
 
 Base.metadata.create_all(engine)

Diff for: sqlalchemy_tutorial/cleanup.py

@@ -10,10 +10,8 @@ def orm_create_user(session: Session, user: User) -> User:
     """
     Create a new instance of our `User` model.
 
-    :param session: SQLAlchemy database session.
-    :type session: Session
-    :param user: User data model for creation.
-    :type user: User
+    :param Session session: SQLAlchemy database session.
+    :param User user: User data model for creation.
 
     :return: User
     """
@@ -34,10 +32,8 @@ def orm_delete_user(session: Session, user: User):
     """
     Delete a user if it exists.
 
-    :param session: SQLAlchemy database session.
-    :type session: Session
-    :param user: User to be deleted.
-    :type user: User
+    :param Session session: SQLAlchemy database session.
+    :param User user: User to be deleted.
 
     :return: None
     """