orphan: clean tree ready for push to hugspace

Dockerfile

@@ -0,0 +1,55 @@
+#--- PREREQS:
+#		- to prep wkg dir:				./_env_config/local_dev/utl_prep_localUnitTest.sh
+#		- to backup wkg dir:			./_env_config/local_dev/utl_prep_localUnitTest.sh --backup
+
+#		- to build dkr image:	  		make sure you stop and remove the container if you are replacing/upgrading; 
+#										or change the version tag# from 0.0.1
+
+
+#--- DOCKER:
+#   	docker build -t img_fastapi_templ:0.0.1 .
+#   	docker create -it -p 7860:7860 --name ctr_fastapi_templ img_fastapi_templ:0.0.1
+#   	docker start -it ctr_fastapi_templ
+#   	docker run -it -p 7860:7860 --name ctr_fastapi_templ img_fastapi_templ:0.0.1
+
+#   	docker push kidcoconut73/<img:tag>
+
+
+#--- use a base image of python
+FROM python:3.8-slim-buster
+
+
+
+# Set up a new user named "user" with user ID 1000
+USER root
+RUN useradd -m -u 1000 user
+
+USER user
+ENV HOME=/home/user \
+	PATH=/home/user/.local/bin:$PATH
+
+#--- set docker image working directory to /app
+RUN mkdir $HOME/app $HOME/app/scripts
+WORKDIR $HOME/app
+
+#--- install all lib dependencies into the image
+COPY --chown=user ./requirements.txt ./requirements.txt
+RUN pip install --no-cache-dir -r ./requirements.txt
+
+#--- copy  files from the local pwd to the docker image /app folder
+#--- .dockerignore:  ensure no local data folders or files (images) are copied into the docker image/container 
+COPY --chown=user ./_env_config/local_dev/utl_dkr_preRun.sh ./scripts/docker/
+COPY --chown=user ./fastapi ./fastapi
+COPY --chown=user ./streamlit ./streamlit
+
+#--- for huggingface;  assume 1:1 mapping between internal and external ports;  and only one port can truly be exposed
+#--- for fastapi;  external 7860;  internal 7860
+#--- for streamlit;  external xxxxx;  internal 39131
+EXPOSE 7860
+
+
+#--- establish environment prereqs
+ENTRYPOINT [ "./scripts/docker/utl_dkr_preRun.sh" ]
+
+
+#--- WORKAROUND:  you may have to stop the docker container through docker desktop, or cmd line eg docker kill <ctr_name>

README.md

@@ -0,0 +1,21 @@
+---
+title: spcdkr fastapi templ
+emoji: 📉
+colorFrom: purple
+colorTo: pink
+sdk: docker
+app_port: 7860
+pinned: false
+license: mit
+---
+
+This app is publically available and run at https://kidcoconut-dkr-fastapi-templ.hf.space/  
+example endpoint:    https://kidcoconut-dkr-fastapi-templ.hf.space/sanity  
+example endpoint:    https://kidcoconut-dkr-fastapi-templ.hf.space/syscheck/sanity  
+  
+streamlit endpoint:  cannot be mounted to fastapi  
+fastapi endpoint:     https://kidcoconut-dkr-fastapi-templ.hf.space/api  
+gradio:                   https://kidcoconut-dkr-fastapi-templ.hf.space/gradio  
+docs:                      https://kidcoconut-dkr-fastapi-templ.hf.space/docs  
+  
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference  

_env_config/local_dev/utl_dkr_preRun.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+#--- Note:  this file is designed to run locally as well as within docker to prep the environment
+#--- Entry:  this script is assumed to run from the /app root folder
+#--- Usage:  ./_env_config/local_dev/utl_dkr_preRun.sh
+
+#--- for volume initialization; ensure folders are in place; assume:  we are in the /app folder
+
+
+<<blockComment 
+- 
+blockComment
+echo -e "INFO(utl_dkr_preRun):\t Initializing ..."
+
+strpth_pwd=$(pwd)
+strpth_scriptLoc=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+strpth_scrHome="${strpth_scriptLoc}/../"
+strpth_appHome="${strpth_scrHome}../"
+strpth_scrModels="${strpth_scrHome}models/"
+
+#echo "strpth_appHome = ${strpth_appHome}"
+
+
+#--- for fastapi;  external 7860;  internal 7860
+echo "INFO:  starting fastapi ..."
+uvicorn --app-dir=./fastapi entry_fastapi:app --reload --workers 1 --host 0.0.0.0 --port 7860 &          #--- specify a non-root app dir
+
+#--- for streamlit;  external 49131;  internal 39131
+#--- note:  streamlit cannot be mounted into fastapi;  you need nginx to run in parallel
+echo "INFO:  starting streamlit ..."
+streamlit run ./streamlit/entry_streamlit.py --server.port=39131 --server.maxUploadSize=2000            #--- & run in the background
+
+
+
+<<blockErrorLog
+blockErrorLog

fastapi/ABOUTME.md

@@ -0,0 +1,6 @@
+#   ABOUTME:  fastapi
+##      Purpose:    this environment is used to API endpoints
+##      Prereq:     
+##      - 
+
+

fastapi/entry_fastapi.py

@@ -0,0 +1,159 @@
+'''
+    purpose:     fastAPI routing 
+
+    refs:
+        fast api behind proxy/root_path:    https://fastapi.tiangolo.com/advanced/behind-a-proxy/
+'''
+
+from fastapi import FastAPI
+from fastapi.responses import HTMLResponse, RedirectResponse
+from fastapi import APIRouter, Request, Response
+from fastapi.templating import Jinja2Templates
+import uvicorn
+import gradio as gr
+
+#--- import custom libraries
+#import lib.utils as libUtils
+
+
+#--- imported route handlers
+#from routes.api.rte_api import rteApi
+
+
+#--- fastAPI self doc descriptors
+description = """
+    Prototype:  FastApi in Docker on Huggingface
+    
+    <insert purpose>
+
+    ## key business benefit #1
+    ## key business benefit #2
+    ## key business benefit #3
+
+    You will be able to:
+    * key feature #1
+    * key feature #2
+    * key feature #3
+"""
+
+#--- main fast api app
+app = FastAPI(
+    title="Prototype:  Fastapi in docker",
+    description=description,
+    version="0.0.1",
+    terms_of_service="http://example.com/terms/",
+    contact={
+        "name": "Iain McKone",
+        "email": "iain.mckone@gmail.com",
+    },
+    license_info={
+        "name": "MIT",
+        "url": "http://opensource.org/licenses/MIT",
+    },
+    openapi_url="/api/v1/openapi.json"
+)
+
+io = gr.Interface(lambda x: "Hello, " + x + "!", "textbox", "textbox")
+app = gr.mount_gradio_app(app, io, path="/gradio_svc")
+
+
+#--- configure route handlers
+#app.include_router(rteApi, prefix="/api")
+#app.include_router(rteQa, prefix="/qa")
+
+
+#m_kstrPath_templ = libUtils.pth_templ
+#m_templRef = Jinja2Templates(directory=str(m_kstrPath_templ))
+
+
+""" def get_jinja2Templ(request: Request, pdfResults, strParamTitle, lngNumRecords, blnIsTrain=False, blnIsSample=False):
+    lngNumRecords = min(lngNumRecords, libUtils.m_klngMaxRecords)
+    if (blnIsTrain):  strParamTitle = strParamTitle + " - Training Data"
+    if (not blnIsTrain):  strParamTitle = strParamTitle + " - Test Data"
+    if (blnIsSample):  lngNumRecords = libUtils.m_klngSampleSize
+    strParamTitle = strParamTitle + " - max " + str(lngNumRecords) + " rows"
+
+    kstrTempl = 'templ_showDataframe.html'
+    jsonContext = {'request': request, 
+                'paramTitle': strParamTitle,
+                'paramDataframe': pdfResults.sample(lngNumRecords).to_html(classes='table table-striped')
+            }
+    result = m_templRef.TemplateResponse(kstrTempl, jsonContext)
+    return result """
+
+
+#--- get main ui/ux entry point
+@app.get('/')
+def index():
+
+    return {
+        "message": "Landing page:  prototype for fastApi"
+    }
+
+@app.get('/api')
+def rte_api():
+
+    return {
+        "message": "Landing page:  prototype for fastApi"
+    }
+
+@app.get('/gradio')
+def rte_gradio():
+
+    #return {
+    #    "message": "Landing page:  this is where gradio would start from if we could mount with fastapi"
+    #} 
+    return RedirectResponse("/gradio_svc")
+
+
+@app.get('/streamlit')
+def rte_streamlit():
+
+    return {
+        "message": "Landing page:  this is where streamlit would start from if we could mount with fastapi"
+    }
+
+@app.get('/shiny')
+def rte_shiny():
+
+    return {
+        "message": "Landing page:  this is where shiny would start mounted with fastapi"
+    }
+
+@app.get('/syscheck/{check_id}')
+async def syscheck(check_id: str): 
+    from os import system
+    #import commands
+
+    print("TRACE: fastapi.syscheck ... {check_id} ", check_id)
+
+    if (check_id=='apt_list'): 
+        print("TRACE: fastapi.syscheck ... {apt_list} ")
+        m_sysMsg = system("apt list --installed")
+        return {"message:  syscheck apt list complete " + str(m_sysMsg)}    
+
+    elif (check_id=='sanity'):
+        print("TRACE: fastapi.syscheck ... {}".format(check_id))
+        return {"message:  syscheck sanity ... ok "} 
+        
+    elif (check_id=='pip_list'): 
+        print("TRACE: fastapi.syscheck ... {pip_list} ")
+        m_sysMsg = system("pip list")
+        return {"message:  syscheck pip list complete " + str(m_sysMsg)}    
+
+    else:
+        return {"message": "fastApi: syscheck {check_id} " + check_id}
+
+
+@app.get('/sanity')
+async def sanity():
+    print("TRACE: fastapi.sanity ... {}")
+    return {"message:  syscheck sanity ... ok "} 
+
+
+if __name__ == '__main__':
+    #uvicorn.run("main:app", host="0.0.0.0", port=49132, reload=True)
+    #uvicorn --app-dir=./fastapi entry_fastapi:app --reload --workers 1 --host 0.0.0.0 --port 7860 &          #--- specify a non-root app dir
+    uvicorn.run("fastapi.entry_fastapi:app", reload=True, workers=1, host="0.0.0.0", port=49132)
+#CMD ["uvicorn", "main:app", "--host=0.0.0.0", "--reload"]
+

gradio/ABOUTME.md

@@ -0,0 +1,6 @@
+#   ABOUTME:  gradio
+##      Purpose:    this environment is used to host a gradio UI
+##      Prereq:     
+##      - 
+
+

requirements.txt

@@ -0,0 +1,111 @@
+
+fastapi==0.111.0
+gradio==4.37.2
+shiny==0.10.2
+streamlit==1.36.0
+uvicorn==0.30.1
+
+#--- 20240716:  pip list on docker
+#Package                   Version
+#------------------------- -----------
+#aiofiles                  23.2.1
+#altair                    5.3.0
+#annotated-types           0.7.0
+#anyio                     4.4.0
+#appdirs                   1.4.4
+# asgiref                   3.8.1
+# attrs                     23.2.0
+# blinker                   1.8.2
+# cachetools                5.3.3
+# certifi                   2024.7.4
+# charset-normalizer        3.3.2
+# click                     8.1.7
+# contourpy                 1.1.1
+# cycler                    0.12.1
+# dnspython                 2.6.1
+# email_validator           2.2.0
+# exceptiongroup            1.2.1
+# fastapi                   0.111.0
+# fastapi-cli               0.0.4
+# ffmpy                     0.3.2
+# filelock                  3.15.4
+# fonttools                 4.53.1
+# fsspec                    2024.6.1
+# gitdb                     4.0.11
+# GitPython                 3.1.43
+# gradio                    4.37.2
+# gradio_client             1.0.2
+# h11                       0.14.0
+# htmltools                 0.5.2
+# httpcore                  1.0.5
+# httptools                 0.6.1
+# httpx                     0.27.0
+# huggingface-hub           0.23.4
+# idna                      3.7
+# importlib_resources       6.4.0
+# Jinja2                    3.1.4
+# jsonschema                4.23.0
+# jsonschema-specifications 2023.12.1
+# kiwisolver                1.4.5
+# linkify-it-py             2.0.3
+# markdown-it-py            3.0.0
+# MarkupSafe                2.1.5
+# matplotlib                3.7.5
+# mdit-py-plugins           0.4.1
+# mdurl                     0.1.2
+# numpy                     1.24.4
+# orjson                    3.10.6
+# packaging                 24.1
+# pandas                    2.0.3
+# pillow                    10.4.0
+# pip                       23.0.1
+# pkgutil_resolve_name      1.3.10
+# prompt-toolkit            3.0.36
+# protobuf                  5.27.2
+# pyarrow                   16.1.0
+# pydantic                  2.8.2
+# pydantic_core             2.20.1
+# pydeck                    0.9.1
+# pydub                     0.25.1
+# Pygments                  2.18.0
+# pyparsing                 3.1.2
+# python-dateutil           2.9.0.post0
+# python-dotenv             1.0.1
+# python-multipart          0.0.9
+# pytz                      2024.1
+# PyYAML                    6.0.1
+# questionary               2.0.1
+# referencing               0.35.1
+# requests                  2.32.3
+# rich                      13.7.1
+# rpds-py                   0.19.0
+# ruff                      0.5.1
+# semantic-version          2.10.0
+# setuptools                57.5.0
+# shellingham               1.5.4
+# shiny                     0.10.2
+# six                       1.16.0
+# smmap                     5.0.1
+# sniffio                   1.3.1
+# starlette                 0.37.2
+# streamlit                 1.36.0
+# tenacity                  8.5.0
+# toml                      0.10.2
+# tomlkit                   0.12.0
+# toolz                     0.12.1
+# tornado                   6.4.1
+# tqdm                      4.66.4
+# typer                     0.12.3
+# typing_extensions         4.12.2
+# tzdata                    2024.1
+# uc-micro-py               1.0.3
+# ujson                     5.10.0
+# urllib3                   2.2.2
+# uvicorn                   0.30.1
+# uvloop                    0.19.0
+# watchdog                  4.0.1
+# watchfiles                0.22.0
+# wcwidth                   0.2.13
+# websockets                11.0.3
+# wheel                     0.40.0
+# zipp                      3.19.2

streamlit/ABOUTME.md

@@ -0,0 +1,6 @@
+#   ABOUTME:  streamlit
+##      Purpose:    this environment is used to host a streamlit UI
+##      Prereq:     
+##      - 
+
+

streamlit/entry_streamlit.py

@@ -0,0 +1,23 @@
+'''
+    toExecute:  (from root app folder) ... streamlit run entry_streamlit.py
+'''
+import streamlit as st
+#import uix.lit_sidebar as litSideBar
+
+
+#--- streamlit:  specify title and logo
+st.set_page_config(
+            page_title='Protoype - Fastapi with Streamlit Landing Page', 
+            #page_icon='https://cdn.freebiesupply.com/logos/thumbs/1x/nvidia-logo.png', 
+            layout="wide")
+st.header('\
+    Protoyping Fastapi and Streamlit \
+    on Docker \
+    within Huggingface space \
+')
+#st.markdown("##### Iain McKone (Deployment Lead) [LinkedIn](%s)" % "https://linkedin.com/in/iainmckone")
+st.markdown('---')
+
+
+#--- streamlit:  add a sidebar 
+#litSideBar.init()