initial commit

.dockerignore

@@ -0,0 +1,11 @@
+.env
+.env-example
+.git/
+.github
+.gitignore
+.idea
+.mypy_cache
+.pre-commit-config.yaml
+.ruff_cache
+Dockerfile
+docker-compose.yml

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/pull_request_template.md

@@ -0,0 +1,12 @@
+Thank you for contributing!
+Before submitting this PR, please make sure:
+
+- [ ] Your code builds clean without any errors or warnings
+- [ ] Your code doesn't break anything we can't fix
+- [ ] You have added appropriate tests
+
+Please check one or more of the following to describe the nature of this PR:
+- [ ] New feature
+- [ ] Bug fix
+- [ ] Documentation
+- [ ] Other

.github/workflows/check-file-size-limit.yml

@@ -0,0 +1,14 @@
+name: 10 MB file size limit
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  check-file-sizes:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check large files
+        uses: ActionsDesk/lfs-warning@v2.0
+        with:
+          filesizelimit: 10485760 # this is 10MB so we can sync to HF Spaces
+          token: ${{ secrets.WORKFLOW_GIT_ACCESS_TOKEN }}

.github/workflows/docker-hub.yml

@@ -0,0 +1,32 @@
+name: Push to Docker Hub
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+
+jobs:
+  build-and-push-docker:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+        token: ${{ secrets.WORKFLOW_GIT_ACCESS_TOKEN }}
+
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v1
+      with:
+        username: joshuasundance
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+    - name: Build Docker image
+      run: |
+        docker build \
+          --target runtime \
+          -t joshuasundance/streamlit-gpt4o:${{ github.ref_name }} \
+          -t joshuasundance/streamlit-gpt4o:latest \
+          .
+
+    - name: Push to Docker Hub
+      run: docker push -a joshuasundance/streamlit-gpt4o

.github/workflows/hf-space.yml

@@ -0,0 +1,21 @@
+name: Push to HuggingFace Space
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  push-to-huggingface:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+        token: ${{ secrets.WORKFLOW_GIT_ACCESS_TOKEN }}
+
+    - name: Push to HuggingFace Space
+      env:
+        HF_TOKEN: ${{ secrets.HF_TOKEN }}
+      run: |
+        git push https://joshuasundance:$HF_TOKEN@huggingface.co/spaces/joshuasundance/streamlit-gpt4o main

.gitignore

@@ -0,0 +1,92 @@
+*$py.class
+*.chainlit
+*.chroma
+*.cover
+*.egg
+*.egg-info/
+*.env
+.env*
+*.langchain.db
+*.log
+*.manifest
+*.mo
+*.pot
+*.py,cover
+*.py[cod]
+*.sage.py
+*.so
+*.spec
+.DS_STORE
+.Python
+.cache
+.coverage
+.coverage.*
+.dmypy.json
+.idea/
+.eggs/
+.env
+.hypothesis/
+.installed.cfg
+.ipynb_checkpoints
+.mypy_cache/
+.nox/
+.pyre/
+.pytest_cache/
+.python-version
+.ropeproject
+.ruff_cache/
+.scrapy
+.spyderproject
+.spyproject
+.tox/
+.venv
+.vscode
+.webassets-cache
+/site
+ENV/
+MANIFEST
+__pycache__
+__pycache__/
+__pypackages__/
+build/
+celerybeat-schedule
+celerybeat.pid
+coverage.xml
+credentials.json
+data/
+db.sqlite3
+db.sqlite3-journal
+develop-eggs/
+dist/
+dmypy.json
+docs/_build/
+downloads/
+eggs/
+env.bak/
+env/
+fly.toml
+htmlcov/
+instance/
+ipython_config.py
+junk/
+lib/
+lib64/
+local_settings.py
+models/*.bin
+nosetests.xml
+notebooks/scratch/
+parts/
+pip-delete-this-directory.txt
+pip-log.txt
+pip-wheel-metadata/
+profile_default/
+sdist/
+share/python-wheels/
+storage
+target/
+token.json
+var/
+venv
+venv.bak/
+venv/
+wheels/

.pre-commit-config.yaml

@@ -0,0 +1,61 @@
+# Don't know what this file is? See https://pre-commit.com/
+#   pip install pre-commit
+#   pre-commit install
+#   pre-commit autoupdate
+# Apply to all files without commiting:
+#   pre-commit run --all-files
+#   I recommend running this until you pass all checks, and then commit.
+#   Fix what you need to and then let the pre-commit hooks resolve their conflicts.
+#   You may need to git add -u between runs.
+exclude: "AI_CHANGELOG.md"
+repos:
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.4.4"
+    hooks:
+    -   id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --ignore, E501]
+-   repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.10.0
+    hooks:
+    -   id: shellcheck
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    -   id: check-ast
+    -   id: check-builtin-literals
+    -   id: check-merge-conflict
+    -   id: check-symlinks
+    -   id: check-toml
+    -   id: check-xml
+    -   id: debug-statements
+    -   id: check-case-conflict
+    -   id: check-docstring-first
+    -   id: check-executables-have-shebangs
+    -   id: check-json
+#    -   id: check-yaml
+    -   id: debug-statements
+    -   id: fix-byte-order-marker
+    -   id: detect-private-key
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: mixed-line-ending
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+    -   id: black
+-   repo: https://github.com/asottile/add-trailing-comma
+    rev: v3.1.0
+    hooks:
+    -   id: add-trailing-comma
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.10.0
+    hooks:
+    -   id: mypy
+        additional_dependencies:
+            - types-requests
+-   repo: https://github.com/PyCQA/bandit
+    rev: 1.7.8
+    hooks:
+    -   id: bandit
+        args: ["-x", "tests/*.py", "-s", "B113"]

Dockerfile

@@ -0,0 +1,19 @@
+FROM python:3.11-slim-bookworm
+
+RUN adduser --uid 1000 --disabled-password --gecos '' appuser
+USER 1000
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PATH="/home/appuser/.local/bin:$PATH"
+
+RUN pip install --user --no-cache-dir --upgrade pip
+
+COPY ./requirements.txt /home/appuser/requirements.txt
+RUN pip install --user --no-cache-dir  --upgrade -r /home/appuser/requirements.txt
+
+COPY ./streamlit-gpt4o/ /home/appuser/streamlit-gpt4o/
+
+WORKDIR /home/appuser/streamlit-gpt4o
+
+CMD ["streamlit", "run", "/home/appuser/streamlit-gpt4o/app.py", "--server.port", "7860", "--server.address", "0.0.0.0"]

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Joshua Sundance Bailey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,9 @@
+# streamlit-gpt4o
+
+A Streamlit component that enables a rich multimodal chat interface, allowing users to input text and upload images within Streamlit applications.
+
+`[...]`
+
+# TODO
+
+- [ ] Make a README ;)

bumpver.toml

@@ -0,0 +1,16 @@
+[bumpver]
+current_version = "0.0.1"
+version_pattern = "MAJOR.MINOR.PATCH[-TAG]"
+commit_message = "Bump version {old_version} -> {new_version}"
+tag_message = "{new_version}"
+tag_scope = "branch"
+pre_commit_hook = ""
+post_commit_hook = ""
+commit = true
+tag = true
+push = true
+
+[bumpver.file_patterns]
+"bumpver.toml" = [
+    'current_version = "{version}"',
+]

docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3.8'
+
+services:
+  streamlit-gpt4o:
+    build: .
+    ports:
+      - "${APP_PORT:-7860}:${APP_PORT:-7860}"
+    command: [
+      "streamlit", "run",
+      "/home/appuser/streamlit-gpt4o/app.py",
+      "--server.port", "${APP_PORT:-7860}",
+      "--server.address", "0.0.0.0"
+    ]

requirements.txt

@@ -0,0 +1,8 @@
+https://github.com/joshuasundance-swca/st-multimodal-chatinput/releases/download/v0.1.7-experimental-unapproved-text-color/st_multimodal_chatinput-0.1.7-py3-none-any.whl
+langchain
+langchain-openai
+langsmith
+openai
+pillow>=10.0.1 # not directly required, pinned by Snyk to avoid a vulnerability
+streamlit
+tiktoken

streamlit-gpt4o/app.py

@@ -0,0 +1,168 @@
+import logging
+import os
+from datetime import datetime
+from uuid import uuid4
+
+import streamlit as st
+from langchain_community.chat_message_histories import (
+    StreamlitChatMessageHistory,
+)
+from langchain_core.messages import HumanMessage
+from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder
+from langchain_core.runnables.history import RunnableWithMessageHistory
+from langchain_openai import ChatOpenAI
+from st_multimodal_chatinput import multimodal_chatinput
+
+logging.basicConfig(level=logging.DEBUG)
+
+
+def chat_input_to_human_message(chat_input: dict) -> HumanMessage:
+    text = chat_input.get("text", "")
+    images = chat_input.get("images", [])
+    human_message = HumanMessage(
+        content=[
+            {
+                "type": "text",
+                "text": text,
+            },
+        ]
+        + [
+            {
+                "type": "image_url",
+                "image_url": {
+                    "url": image,
+                },
+            }
+            for image in images
+        ],
+    )
+    return human_message
+
+
+def render_human_contents(msg: HumanMessage) -> None:
+    for d in msg.content:
+        if d["type"] == "text":
+            st.write(d["text"])
+        elif d["type"] == "image_url":
+            st.image(d["image_url"]["url"], use_column_width=True)
+
+
+prompt = ChatPromptTemplate.from_messages(
+    [
+        (
+            "system",
+            "You are a multimodal AI chatbot having a conversation with a human. "
+            "You can accept text and images as input, but you can only respond with text. "
+            "The current time is {date_time}.",
+        ),
+        MessagesPlaceholder(variable_name="history"),
+        MessagesPlaceholder(variable_name="input"),
+    ],
+).partial(date_time=datetime.now().strftime("%B %d, %Y %H:%M:%S"))
+
+
+llm = None
+runnable = None
+with_message_history = None
+
+langsmith_api_key = None
+langsmith_project_name = None
+langsmith_client = None
+
+chat_input_dict = None
+chat_input_human_message = None
+
+history = StreamlitChatMessageHistory(key="chat_messages")
+
+if not st.session_state.get("session_id", None):
+    st.session_state.session_id = str(uuid4())
+
+top = st.container()
+bottom = st.container()
+
+with st.sidebar:
+    openai_api_key = st.text_input("OpenAI API Key", type="password")
+    use_gpt4o = st.toggle(label="`gpt-4-turbo` ⇄ `gpt-4o`", value=True)
+    model_option = "gpt-4o" if use_gpt4o else "gpt-4-turbo"
+    if openai_api_key:
+        llm = ChatOpenAI(
+            model=model_option,
+            streaming=True,
+            verbose=True,
+            openai_api_key=openai_api_key,
+        )
+        runnable = prompt | llm
+        with_message_history = RunnableWithMessageHistory(
+            runnable,
+            lambda _: history,
+            input_messages_key="input",
+            history_messages_key="history",
+        )
+
+    langsmith_api_key = st.text_input("LangSmith API Key", type="password")
+    langsmith_project_name = st.text_input(
+        "LangSmith Project Name",
+        value="streamlit-gpt4o",
+    )
+    langsmith_endpoint = st.text_input(
+        "LangSmith Endpoint",
+        value="https://api.smith.langchain.com",
+    )
+    if langsmith_api_key and langsmith_project_name:
+        os.environ["LANGCHAIN_API_KEY"] = langsmith_api_key
+        os.environ["LANGCHAIN_PROJECT"] = langsmith_project_name
+        os.environ["LANGCHAIN_ENDPOINT"] = langsmith_endpoint
+        os.environ["LANGCHAIN_TRACING_V2"] = "true"
+
+    else:
+        for key in (
+            "LANGCHAIN_API_KEY",
+            "LANGCHAIN_PROJECT",
+            "LANGCHAIN_ENDPOINT",
+            "LANGCHAIN_TRACING_V2",
+        ):
+            os.environ.pop(key, None)
+
+    st.markdown(
+        f"## Current session ID\n`{st.session_state.get('session_id', '<none>')}`",
+    )
+    if st.button("Clear message history"):
+        history.clear()
+        st.session_state.session_id = None
+        st.rerun()
+
+
+if not with_message_history:
+    st.error("Please enter an OpenAI API key in the sidebar.")
+
+else:
+    with bottom:
+        chat_input_dict = multimodal_chatinput(text_color="black")
+        if chat_input_dict:
+            chat_input_human_message = chat_input_to_human_message(chat_input_dict)
+
+    with top:
+        for msg in history.messages:
+            if msg.type.lower() in ("user", "human"):
+                with st.chat_message("human"):
+                    render_human_contents(msg)
+            elif msg.type.lower() in ("ai", "assistant", "aimessagechunk"):
+                with st.chat_message("ai"):
+                    st.write(msg.content)
+
+        if chat_input_human_message:
+
+            with st.chat_message("human"):
+                render_human_contents(chat_input_human_message)
+
+            with st.chat_message("ai"):
+                st.write_stream(
+                    with_message_history.stream(
+                        {"input": [chat_input_human_message]},
+                        {
+                            "configurable": {"session_id": st.session_state.session_id},
+                        },
+                    ),
+                )
+
+            chat_input_human_message = None