Merge branch 'main' into next

README.md

@@ -50,7 +50,7 @@ make docker-push    # run Docker compose to containerize your application
 - [make](https://gnuwin32.sourceforge.net/packages/make.htm). _pre-installed on Linux and macOS._
 - [OpenAI platform API key](https://platform.openai.com/).
   _If you're new to OpenAI API then see [How to Get an OpenAI API Key](./doc/OPENAI_API_GETTING_STARTED_GUIDE.md)_
-- [Python 3.11](https://www.python.org/downloads/): for creating virtual environment used for building AWS Lambda Layer, and locally by pre-commit linters and code formatters.
+- [Python 3.11](https://www.python.org/downloads/): for creating virtual environment.
 - [Docker](https://docs.docker.com/): the Docker run-time environment for your operating system. Can be installed as a desktop application or as a service (daemon)
 - [Docker Compose](https://docs.docker.com/compose/install/): used to create your production container.
 

app/tests/test_application.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # pylint: disable=wrong-import-position
 # pylint: disable=R0801
-"""Test lambda_openai_v2 function."""
+"""Test application."""
 
 # python stuff
 import os
@@ -21,7 +21,7 @@
 
 
 class TestApplication(unittest.TestCase):
-    """Test Index Lambda function."""
+    """Test application."""
 
     def test_application_does_not_crash(self):
         """Test that the application returns a value."""

doc/CONTRIBUTING.md

@@ -50,7 +50,7 @@ On the other hand, if you've forked this repo and are working on your own indepe
 
 ## Python Setup
 
-This project includes four distinct Python project, all located in api/terraform/python. They are located here because each of these projects is deployed to AWS Lambda, which in turn is being actively managed by Terraform.
+This project includes a single Python project located ./app.
 
 Note that this project leverages Dependabot for managing version numbers of all Python packages that are used in this project, regardless of where and how. Versions should always be up to date at the moment that you clone the repo. It therefore should never be necessary for you to manually bump PyPi package version numbers.
 

doc/GOOD_CODING_PRACTICE.md

@@ -10,7 +10,6 @@ Of note:
 
 - [Automated Pull Requests](https://github.com/FullStackWithLawrence/aws-openai/pulls?q=is%3Apr+is%3Aclosed): Github Actions are triggered on pull requests to run any of several different kinds of technology-specific unit tests depending on the contents of the commits included in the PR.
 - [python-dotenv](https://pypi.org/project/python-dotenv/) for storing sensitive data for local development
-- [Pydantic](https://docs.pydantic.dev/latest/) is the most widely used data validation library for Python. We use it for the [Settings](../api/terraform/python/openai_api/common/conf.py) class in this project. It's an important addition because it enforces strong type and business rule validation checking of all of the configuration parameters for the AWS Lambdas, and it ensures that nothing ever changes these values at run-time once they've been set. And this in turn is important because erroneous automation code could otherwise lead to some wildly disastrous results. 😳
 - [.gitignore](./.gitignore) ensures that no sensitive nor useless data accidentally gets pushed to GitHub.
 - [tox.ini](./tox.ini) file for configuring behaviors of Python testing tools
 - [GitHub Actions](https://github.com/features/actions) automates unit testing, semantic release rule checking, and dependabot actions.