Merge pull request #2 from FullStackWithLawrence/next

create docker-based command-line application

Author: lpm0073

.github/actions/tests/pre-commit/action.yml

@@ -22,40 +22,40 @@ runs:
     - name: Check for pre-commit in requirements
       shell: bash
       run: |
-        if ! grep -q "pre-commit" ./requirements.txt; then
-          echo "pre-commit not found in requirements.txt" >&2
+        if ! grep -q "pre-commit" ./requirements/dev.txt; then
+          echo "pre-commit not found in requirements/dev.txt" >&2
           exit 1
         fi
 
     - name: Check for black in requirements
       shell: bash
       run: |
-        if ! grep -q "black" ./requirements.txt; then
-          echo "black not found in requirements.txt" >&2
+        if ! grep -q "black" ./requirements/dev.txt; then
+          echo "black not found in requirements/dev.txt" >&2
           exit 1
         fi
 
     - name: Check for flake8 in requirements
       shell: bash
       run: |
-        if ! grep -q "flake8" ./requirements.txt; then
-          echo "flake8 not found in requirements.txt" >&2
+        if ! grep -q "flake8" ./requirements/dev.txt; then
+          echo "flake8 not found in requirements/dev.txt" >&2
           exit 1
         fi
 
     - name: Check for flake8-coding in requirements
       shell: bash
       run: |
-        if ! grep -q "flake8-coding" ./requirements.txt; then
-          echo "flake8-coding not found in requirements.txt" >&2
+        if ! grep -q "flake8-coding" ./requirements/dev.txt; then
+          echo "flake8-coding not found in requirements/dev.txt" >&2
           exit 1
         fi
 
     - name: Cache Python dependencies
       uses: actions/cache@v3
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements/dev.txt') }}
         restore-keys: |
           ${{ runner.os }}-pip
 
@@ -68,7 +68,7 @@ runs:
       shell: bash
       run: |
         python -m pip install --upgrade pip
-        pip install -r ./requirements.txt
+        pip install -r ./requirements/dev.txt
 
     # see: https://pre-commit.ci/lite.html
     - name: pre-commit ci

.github/actions/tests/python/action.yml

@@ -30,40 +30,16 @@ runs:
     - name: Check for openai in requirements
       shell: bash
       run: |
-        if ! grep -q "openai" ./requirements.txt; then
-          echo "openai not found in requirements.txt" >&2
-          exit 1
-        fi
-
-    - name: Check for langchain in requirements
-      shell: bash
-      run: |
-        if ! grep -q "langchain" ./requirements.txt; then
-          echo "langchain not found in requirements.txt" >&2
-          exit 1
-        fi
-
-    - name: Check for langchain-experimental in requirements
-      shell: bash
-      run: |
-        if ! grep -q "langchain-experimental" ./requirements.txt; then
-          echo "langchain-experimental not found in requirements.txt" >&2
-          exit 1
-        fi
-
-    - name: Check for pinecone-client in requirements
-      shell: bash
-      run: |
-        if ! grep -q "pinecone-client" ./requirements.txt; then
-          echo "pinecone-client not found in requirements.txt" >&2
+        if ! grep -q "openai" requirements/prod.txt; then
+          echo "openai not found in requirements/prod.txt" >&2
           exit 1
         fi
 
     - name: Cache Python dependencies
       uses: actions/cache@v3
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements/prod.txt') }}
         restore-keys: |
           ${{ runner.os }}-pip
 
@@ -85,7 +61,7 @@ runs:
     - name: Install dependencies
       shell: bash
       run: |
-        pip install -r ./requirements.txt
+        pip install -r requirements/prod.txt
       env:
         SITE_PACKAGES_PATH: ${{ env.SITE_PACKAGES_PATH }}
 
@@ -95,19 +71,15 @@ runs:
         touch ./.env
         echo "OPENAI_API_ORGANIZATION=${{ env.OPENAI_API_ORGANIZATION }}" >> ./.env
         echo "OPENAI_API_KEY=${{ env.OPENAI_API_KEY }}" >> ./.env
-        echo "PINECONE_API_KEY=${{ env.PINECONE_API_KEY }}" >> ./.env
-        echo "PINECONE_ENVIRONMENT=${{ env.PINECONE_ENVIRONMENT }}" >> ./.env
         echo "DEBUG_MODE=False" >> ./.env
       env:
         OPENAI_API_ORGANIZATION: ${{ inputs.openai-api-organization }}
         OPENAI_API_KEY: ${{ inputs.openai-api-key }}
-        PINECONE_API_KEY: ${{ inputs.pinecone-api-key }}
-        PINECONE_ENVIRONMENT: ${{ inputs.pinecone-environment }}
 
     - name: Run Python unit tests
       shell: bash
       env:
         GITHUB_ACTIONS: "true"
         DEBUG_MODE: "true"
       run: |
-        make api-test
+        make test

.github/workflows/precommitVersionBumps.yml

@@ -44,7 +44,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements/**') }}
           restore-keys: |
             ${{ runner.os }}-pip
 
@@ -66,7 +66,8 @@ jobs:
       - name: Install dependencies
         shell: bash
         run: |
-          pip install -r ./requirements.txt
+          pip install -r ./requirements/dev.txt
+          pip install -r ./requirements/prod.txt
         env:
           SITE_PACKAGES_PATH: ${{ env.SITE_PACKAGES_PATH }}
 

.github/workflows/pullRequestController.yml

@@ -47,7 +47,7 @@ on:
     paths:
       - "**.py"
       - "**.js"
-      - "**.requirements.txt"
+      - "**./requirements/**"
       - "**.package.json"
       - "./app/**"
 
@@ -109,7 +109,7 @@ jobs:
         id: file_changes
         run: |
           echo "::set-output name=files_changed::$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep '\.py$' || true)"
-          echo "::set-output name=requirements_changed::$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep 'requirements.txt$' || true)"
+          echo "::set-output name=requirements_changed::$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep 'requirements$' || true)"
 
       - name: Run Python tests
         if: steps.file_changes.outputs.files_changed != '' || steps.file_changes.outputs.requirements_changed != ''

.github/workflows/testsPython.yml

@@ -23,17 +23,6 @@ jobs:
         id: checkout
         uses: actions/checkout@v4
 
-      - name: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v4
-        with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: ${{ secrets.AWS_REGION }}
-
-      - name: Get IAM user info
-        run: |
-          aws sts get-caller-identity | sed -E 's/(arn:aws:iam::)[0-9]+(:user\/\w+)/\1************\2/' | jq '.Account="************"'
-
       - name: Run Python tests
         uses: ./.github/actions/tests/python
         with:

.pre-commit-config.yaml

@@ -8,14 +8,6 @@ repos:
       - id: codespell
         args: ["--ignore-words=codespell.txt"]
         exclude: '\.svg$'
-  - repo: local
-    hooks:
-      - id: eslint
-        name: eslint
-        entry: bash -c 'cd client && npx eslint'
-        language: node
-        types: [javascript]
-        files: ^client/
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8
     hooks:
@@ -63,7 +55,6 @@ repos:
       - id: detect-aws-credentials
       - id: detect-private-key
       - id: end-of-file-fixer
-      - id: forbid-new-submodules
       - id: trailing-whitespace
       - id: check-case-conflict
       - id: check-merge-conflict

Dockerfile

@@ -3,18 +3,20 @@
 FROM python:3.11
 
 # Set the working directory to /app
-WORKDIR /app
+WORKDIR /dist
 
 # Copy the current directory contents into the container at /app
-COPY python/ /app
+COPY app /dist/app
+COPY requirements/prod.txt requirements.txt
 
 # Set environment variables
 ENV ENVIRONMENT dev
 ENV OPENAI_API_KEY ""
+ENV PYTHONPATH /dist
 
 # Install any needed packages specified in requirements.txt
 RUN pip install --no-cache-dir -r requirements.txt
 
 
 # Run the application when the container launches
-CMD ["python", "console.py"]
+CMD ["python", "app/hello_world.py"]

Makefile

@@ -1,4 +1,5 @@
 SHELL := /bin/bash
+CONTAINER_NAME := hello_world
 
 ifeq ($(OS),Windows_NT)
     PYTHON = python.exe
@@ -15,7 +16,7 @@ else
     $(shell echo -e "OPENAI_API_ORGANIZATION=PLEASE-ADD-ME\nOPENAI_API_KEY=PLEASE-ADD-ME\nENVIRONMENT=dev\n" >> .env)
 endif
 
-.PHONY: analyze pre-commit init lint clean test
+.PHONY: analyze pre-commit init lint clean test build release
 
 # Default target executed when no arguments are given to make.
 all: help
@@ -44,12 +45,13 @@ init:
 	$(PYTHON) -m venv venv && \
 	$(ACTIVATE_VENV) && \
 	$(PIP) install --upgrade pip && \
-	$(PIP) install -r requirements.txt && \
+	$(PIP) install -r requirements/dev.txt && \
+	$(PIP) install -r requirements/prod.txt && \
 	deactivate && \
 	pre-commit install
 
 test:
-	echo "No tests yet"
+	python -m unittest discover -s app/
 
 lint:
 	isort .
@@ -61,6 +63,13 @@ lint:
 clean:
 	rm -rf venv
 
+build:
+	docker build -t ${CONTAINER_NAME} .
+
+run:
+	source .env && \
+	docker run -it -e OPENAI_API_KEY=${OPENAI_API_KEY} -e ENVIRONMENT=prod ${CONTAINER_NAME}
+
 
 ######################
 # HELP

README.md

@@ -2,7 +2,6 @@
 
 [![FullStackWithLawrence](https://a11ybadges.com/badge?text=FullStackWithLawrence&badgeColor=orange&logo=youtube&logoColor=282828)](https://www.youtube.com/@FullStackWithLawrence)<br>
 [![OpenAI](https://a11ybadges.com/badge?logo=openai)](https://platform.openai.com/)
-[![LangChain](https://a11ybadges.com/badge?text=LangChain&badgeColor=0834ac)](https://www.langchain.com/)
 [![Amazon AWS](https://a11ybadges.com/badge?logo=amazonaws)](https://aws.amazon.com/)
 [![ReactJS](https://a11ybadges.com/badge?logo=react)](https://react.dev/)
 [![Python](https://a11ybadges.com/badge?logo=python)](https://www.python.org/)
@@ -15,7 +14,33 @@
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
 [![hack.d Lawrence McDaniel](https://img.shields.io/badge/hack.d-Lawrence%20McDaniel-orange.svg)](https://lawrencemcdaniel.com)
 
-A Python "Hello World" application that also demonstrates the OpenAI API and usage of Docker.
+A Python "Hello World" application that demonstrates the OpenAI API and usage of Docker Compose to containerize your project. This is a command line utility that returns the value "Hello World" in the written language of your choice.
+
+## Quick Start
+
+```console
+git clone https://github.com/FullStackWithLawrence/openai-hello-world.git
+cd openai-hello-world
+make init    # create a virtual environment
+make build   # run Docker compose to containerize your application
+make run     # run the application as a Docker container
+```
+
+To run from the command line:
+
+```console
+source venv/bin/activate
+python3 -m app.hello_world "Chinese"
+```
+
+Sample output:
+
+```console
+% make run
+Hello World
+Your language: Mandarin
+你好，世界 -- (Mandarin)
+```
 
 ## Requirements
 
@@ -25,7 +50,8 @@ A Python "Hello World" application that also demonstrates the OpenAI API and usa
   _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.
 - [NodeJS](https://nodejs.org/en/download): used with NPM for local ReactJS developer environment, and for configuring/testing Semantic Release.
-- [Docker Compose](https://docs.docker.com/compose/install/): used by an automated Terraform process to create the AWS Lambda Layer for OpenAI and LangChain.
+- [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.
 
 ## Documentation
 

app/__version__.py

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
 # DO NOT EDIT.
 # Managed via automated CI/CD in .github/workflows/semanticVersionBump.yml.
-__version__ = "0.0.1"
+__version__ = "0.1.0"