feat: upgrading python and structural integrity (#1)

Author: nachatz

.github/workflows/validate.yaml

@@ -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 pip
       run: |

.gitignore

@@ -1,4 +1,8 @@
 .mypy_cache
 __pycache__
 .pytest_cache
-.coverage
+.coverage
+.vscode
+
+# poetry lock -- remove if desired to commit lock file
+poetry.lock

Makefile

@@ -1,28 +1,19 @@
 install:
-	@poetry install --all-extras --with dev	
-
-lock:
-	@poetry lock
+	@poetry install --all-extras --with dev
+	poetry lock
 
 run:
-	@poetry run python3 main.py
+	poetry run python examples/main.py
 
-# Use --check to avoid auto format
 fmt:
-	@poetry run black $(FLAGS) .
+	@poetry run black src tests
 
 mypy:
-	@poetry run mypy .
-
-pylint:
-	@poetry run pylint src
-
-test:
-	@poetry run pytest
+	@poetry run mypy src tests
 
 check: fmt mypy
 	@poetry run prospector --profile prospector.yaml
 
 validate: check
-	@poetry run coverage run --source=lib -m pytest && \
+	@poetry run coverage run --source=src -m pytest && \
 	poetry run coverage report -m 

README.md

@@ -1,4 +1,8 @@
-# End-to-End Python Template
+# End-to-End Python Template w/ Poetry
+[![v2.0.0](https://img.shields.io/badge/version-v2.0.0-blue.svg)](https://github.com/nachatz/python-template)
+[![Test](https://github.com/nachatz/python-template/actions/workflows/validate.yaml/badge.svg)](https://github.com/nachatz/python-template/actions/workflows/validate.yaml)
+[![License](https://img.shields.io/badge/license-Apache%202-brightgreen.svg)](https://github.com/nachatz/python-template/blob/master/LICENSE.txt)
+
 
 This is a Python project template that provides a starting point for building Python applications with essential development tools such as tests, linting, formatting, typing, coverage, and CI/CD setup using Poetry to manage dependencies.
 
@@ -90,7 +94,6 @@ To use this template for your Python project, follow these steps:
 Run 
 ```bash
 make install
-make lock`
 ```
 
 Ensure you have installed **Poetry & Python**
@@ -133,16 +136,12 @@ This project includes a set of make commands to help you manage your development
 
 - `make install`: Install project dependencies, including development extras.
 
-- `make lock`: Lock project dependencies using Poetry.
-
 - `make fmt`: Format code using Black. Use the FLAGS variable to pass additional formatting options. Example: make fmt FLAGS="--exclude some_folder".
 
 - `make mypy`: Run MyPy type checking.
 
 - `make pylint`: Run pylint for code analysis.
 
-- `make test`: Run pytest for testing.
-
 - `make check`: Run formatting and type checking (fmt and mypy).
 
 - `make validate`: Run full validation, including checks, tests, and coverage.

examples/main.py

@@ -0,0 +1,25 @@
+"""
+Python Template Code
+~~~~~~~~~~~~~~~~~~~~~
+
+Sample starter code for enabling immediate development of Python applications
+utilizing pytest, pylint, black, mypy, and poetry for a sustainable e2e solution.
+
+This showcases working with a Python built library
+"""
+
+from project_template.engine import Serializer
+from project_template.models import PostModel
+
+
+def main():
+    """ Application to fetch a PostModel, update it, and pretty-print the result using
+    the 'project_template' library.
+    """
+
+    post: PostModel = Serializer.make_request()
+    Serializer.update_post(post=post)
+    Serializer.pretty_print(post=post)
+
+if __name__ == "__main__":
+    main()