Merge pull request #583 from DefangLabs/jordan/rename-long-sample-names

Shortening some long sample names

Author: jordanstephens

.github/workflows/deploy.yaml

@@ -0,0 +1,21 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    environment: playground
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@v4
+
+    - name: Deploy
+      uses: DefangLabs/defang-github-action@v1.1.0

README.md

@@ -0,0 +1,35 @@
+# Python & Flask & OpenAI
+
+[![1-click-deploy](https://raw.githubusercontent.com/DefangLabs/defang-assets/main/Logos/Buttons/SVG/deploy-with-defang.svg)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-python-openai-template%26template_owner%3DDefangSamples)
+
+## Setup
+
+This sample requires an API key to access the OpenAI API. The name of the config value is referenced in the compose.yaml file. To provide a value for it, you can use the Defang CLI like this:
+
+```
+defang config set --name OPENAI_KEY
+```
+
+and then enter the value when prompted.
+
+## Testing
+
+```
+echo "Hello" | curl -H "Content-Type: application/text" -d @- https://xxxxxxxx/prompt
+```
+
+or
+
+```
+cat prompt.txt | curl -H "Content-Type: application/text" -d @- https://xxxxxxxx/prompt
+```
+
+---
+
+Title: Python & Flask & OpenAI
+
+Short Description: An app that demonstrates how to use the OpenAI API with Python and Flask.
+
+Tags: Python, Flask, OpenAI, AI, Python
+
+Languages: python

app/.gitignore

@@ -0,0 +1,134 @@
+
+# --- Python ---
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/

app/Dockerfile

@@ -0,0 +1,29 @@
+# Use an official Python runtime as a parent image
+FROM python:3.11-slim
+
+# Set the working directory to /app
+WORKDIR /app
+
+# Install required C++11 libraries and ca-certificates
+RUN apt-get update -qq \
+      && apt-get install -y \
+      build-essential \
+      python3-dev \
+      ca-certificates \
+      curl \
+      && apt-get clean \
+      && rm -rf /var/lib/apt/lists/*
+
+# Install any needed packages specified in requirements.txt
+COPY requirements.txt /app/
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy the current directory contents into the container at /app
+COPY . /app
+
+# Make port 5000 available to the world outside this container
+EXPOSE 5000
+
+# Run main when the container launches
+ENTRYPOINT ["uwsgi", "--http", "0.0.0.0:5000", "--master", "-p", "2", "-w", "main:app"]
+USER nobody

app/main.py

@@ -0,0 +1,43 @@
+import os
+import json
+import openai
+from flask import Flask
+from flask import request
+
+
+app = Flask(__name__)
+
+
+@app.route("/")
+def index():
+    return { 'status' : 'ok' }
+
+
+@app.route("/prompt", methods=['POST'])
+def prompt():
+    openai.api_key = os.environ['OPENAI_KEY']
+
+    messages = [ 
+        # System prompt used to set context for the conversation
+        # { "role": "system", "content": "You are an experienced software engineer." }
+    ]
+
+    prompt_text = request.get_data()
+    prompt_text = prompt_text.decode('utf-8')
+
+    # append user prompt from request
+    messages.append({ "role": "user", "content": prompt_text })
+
+    # call the ChatGPT API
+    response = openai.ChatCompletion.create(
+        model="gpt-3.5-turbo",
+        #engine="gpt-4",
+        messages=messages,
+    )
+
+    return { 'status' : 'ok', 'response' : response }
+        
+
+if __name__ == '__main__':
+    app.run(debug=True, host='0.0.0.0')
+

app/requirements.txt

@@ -0,0 +1,3 @@
+uwsgi
+flask
+openai

compose.yaml

@@ -0,0 +1,17 @@
+services:
+  app:
+    restart: unless-stopped
+    build:
+      context: ./app
+      dockerfile: Dockerfile
+    ports:
+      - mode: ingress
+        target: 5000
+    environment:
+      - OPENAI_KEY
+    deploy:
+      resources:
+        reservations:
+          memory: 256M
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:5000/"]