Copy setup from JonSolow/streamlit-template

.devcontainer/devcontainer.json

@@ -0,0 +1,48 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
+{
+	"name": "Existing Docker Compose (Extend)",
+
+	// Update the 'dockerComposeFile' list if you have more compose files or use different names.
+	// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
+	"dockerComposeFile": [
+		"../docker-compose.yml",
+		"docker-compose.yml"
+	],
+
+	// The 'service' property is the name of the service for the container that VS Code should
+	// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
+	"service": "streamlit",
+
+	// The optional 'workspaceFolder' property is the path VS Code should open by default when
+	// connected. This is typically a file mount in .devcontainer/docker-compose.yml
+	"workspaceFolder": "/app",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-python.python"
+			]
+		}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Uncomment the next line if you want start specific services in your Docker Compose config.
+	// "runServices": [],
+
+	// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+	// "shutdownAction": "none",
+
+	// Uncomment the next line to run commands after the container is created.
+	// "postCreateCommand": "cat /etc/os-release",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "devcontainer"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,27 @@
+version: '3.8'
+services:
+  # Update this to the name of the service you want to work with in your docker-compose.yml file
+  streamlit:
+    # Uncomment if you want to override the service's Dockerfile to one in the .devcontainer 
+    # folder. Note that the path of the Dockerfile and context is relative to the *primary* 
+    # docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
+    # array). The sample below assumes your primary file is in the root of your project.
+    #
+    build:
+      dockerfile: ./Dockerfile
+      context: ./
+      target: development
+
+    volumes:
+      # Update this to wherever you want VS Code to mount the folder of your project
+      - .:/app:cached
+
+    # Uncomment the next four lines if you will use a ptrace-based debugger like C++, Go, and Rust.
+    # cap_add:
+    #   - SYS_PTRACE
+    # security_opt:
+    #   - seccomp:unconfined
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: ["/bin/sh -c \"while sleep 1000; do :; done\""]
+ 

.gitignore

@@ -0,0 +1,160 @@
+# 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
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.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
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

Dockerfile

@@ -0,0 +1,36 @@
+# app/Dockerfile
+
+FROM python:3.11-slim as base
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    curl \
+    software-properties-common \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN pip3 install pip-tools
+COPY ./pyproject.toml .
+
+FROM base as pip-service
+
+COPY ./requirements.txt .
+RUN pip3 install -r requirements.txt
+
+FROM pip-service as service-setup
+EXPOSE 8501
+HEALTHCHECK CMD curl --fail http://localhost:8501/_stcore/health
+ENTRYPOINT ["./start.sh"]
+
+FROM pip-service as service
+WORKDIR /app/src
+COPY ./src .
+
+FROM service-setup as development
+WORKDIR /app
+COPY ./dev-requirements.txt .
+RUN pip3 install -r dev-requirements.txt
+
+WORKDIR /app/src

README.md

@@ -10,3 +10,48 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# streamlit-template
+
+Template Repo for Streamlit Application
+
+This repo can be used as a starting point for developing your Streamlit App.
+
+Here are some of the features of the template:
+
+- VSCode .devcontainer for local development: [Documentation](https://code.visualstudio.com/docs/devcontainers/containers)
+  - docker-compose.yml
+  - Dockerfile
+- Linting Configuration [TO-DO] (allows for clean code and quicker detection of possible bugs as one of the first steps in Shift-left testing)
+  - [Black](https://black.readthedocs.io/en/stable/index.html)
+  - [ruff](https://beta.ruff.rs/docs/)
+  - [mypy](https://mypy.readthedocs.io/en/stable/index.html)
+- Unit Tests
+  - [pytest](https://docs.pytest.org/)
+
+# Start Here to Develop
+
+1. Prerequisites
+
+- Install [Visual Studio Code](https://code.visualstudio.com/)
+- Install [Visual Studo Code Extension - Dev containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+- Install [Docker](https://www.docker.com/)
+
+2. Confirm Docker is installed by executing command `docker -v`
+3. Open VSCode to a New Window and open this repository's directory
+4. You may see a notification that the Folder containers a Dev Container configuration file. If so, click on "Reopen in Container"
+
+- If you do not see this notification, press `F1` key and begin typing the following until you can see the option "Dev Containers: Rebuild and reopen in Container".
+- This action will reopen the VSCode within a Docker container suitable to develop and locally run the application.
+
+5. The dev container will start up the Streamlit application.
+
+- To access the application, navigate to http://localhost:8501
+  - The container forwards the port 8501 where the Streamlit application is hosted
+- Any changes made to the code will be reflected in the Streamlit application when you refresh.
+
+6. Now inside the VSCode dev container, to run tests, execute `./tests/run_tests.sh`
+
+- This script has an optional argument `-f` for "fix mode" which allows for configuration of black and ruff to automatically apply fixes.
+
+7. As functions are added to the application, unit tests can/should be added in `tests/unit`, with existing support utilizing the `pytest` library.

dev-requirements.txt

@@ -0,0 +1,153 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile --extra=dev --output-file=dev-requirements.txt pyproject.toml
+#
+altair==5.0.1
+    # via streamlit
+attrs==23.1.0
+    # via
+    #   jsonschema
+    #   referencing
+black==23.7.0
+    # via streamlit-template (pyproject.toml)
+blinker==1.6.2
+    # via streamlit
+cachetools==5.3.1
+    # via streamlit
+certifi==2023.7.22
+    # via requests
+charset-normalizer==3.2.0
+    # via requests
+click==8.1.6
+    # via
+    #   black
+    #   streamlit
+gitdb==4.0.10
+    # via gitpython
+gitpython==3.1.32
+    # via streamlit
+idna==3.4
+    # via requests
+importlib-metadata==6.8.0
+    # via streamlit
+iniconfig==2.0.0
+    # via pytest
+jinja2==3.1.2
+    # via
+    #   altair
+    #   pydeck
+jsonschema==4.19.0
+    # via altair
+jsonschema-specifications==2023.7.1
+    # via jsonschema
+markdown-it-py==3.0.0
+    # via rich
+markupsafe==2.1.3
+    # via jinja2
+mdurl==0.1.2
+    # via markdown-it-py
+mypy==1.5.1
+    # via streamlit-template (pyproject.toml)
+mypy-extensions==1.0.0
+    # via
+    #   black
+    #   mypy
+numpy==1.25.2
+    # via
+    #   altair
+    #   pandas
+    #   pandas-stubs
+    #   pyarrow
+    #   pydeck
+    #   streamlit
+    #   streamlit-template (pyproject.toml)
+packaging==23.1
+    # via
+    #   black
+    #   pytest
+    #   streamlit
+pandas==2.0.3
+    # via
+    #   altair
+    #   streamlit
+    #   streamlit-template (pyproject.toml)
+pandas-stubs==2.0.3.230814
+    # via streamlit-template (pyproject.toml)
+pathspec==0.11.2
+    # via black
+pillow==9.5.0
+    # via streamlit
+platformdirs==3.10.0
+    # via black
+pluggy==1.2.0
+    # via pytest
+protobuf==4.24.0
+    # via streamlit
+pyarrow==12.0.1
+    # via streamlit
+pydeck==0.8.0
+    # via streamlit
+pygments==2.16.1
+    # via rich
+pympler==1.0.1
+    # via streamlit
+pytest==7.4.0
+    # via streamlit-template (pyproject.toml)
+python-dateutil==2.8.2
+    # via
+    #   pandas
+    #   streamlit
+pytz==2023.3
+    # via pandas
+pytz-deprecation-shim==0.1.0.post0
+    # via tzlocal
+referencing==0.30.2
+    # via
+    #   jsonschema
+    #   jsonschema-specifications
+requests==2.31.0
+    # via streamlit
+rich==13.5.2
+    # via streamlit
+rpds-py==0.9.2
+    # via
+    #   jsonschema
+    #   referencing
+ruff==0.0.284
+    # via streamlit-template (pyproject.toml)
+six==1.16.0
+    # via python-dateutil
+smmap==5.0.0
+    # via gitdb
+streamlit==1.25.0
+    # via streamlit-template (pyproject.toml)
+tenacity==8.2.3
+    # via streamlit
+toml==0.10.2
+    # via streamlit
+toolz==0.12.0
+    # via altair
+tornado==6.3.3
+    # via streamlit
+types-pytz==2023.3.0.1
+    # via pandas-stubs
+typing-extensions==4.7.1
+    # via
+    #   mypy
+    #   streamlit
+tzdata==2023.3
+    # via
+    #   pandas
+    #   pytz-deprecation-shim
+tzlocal==4.3.1
+    # via streamlit
+urllib3==2.0.4
+    # via requests
+validators==0.21.2
+    # via streamlit
+watchdog==3.0.0
+    # via streamlit
+zipp==3.16.2
+    # via importlib-metadata

docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  streamlit:
+    build:
+      dockerfile: ./Dockerfile
+      context: ./
+      target: service
+    ports:
+      - '8501:8501'
+    environment:
+      - USER_ID=1000
+      - GROUP_ID=1000

pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools"]
+
+[project]
+requires-python = ">=3.9"
+version = "1"
+name = "streamlit-template"
+dependencies = [
+    "streamlit",
+    "numpy",
+    "pandas",
+    ]
+
+[project.optional-dependencies]
+dev = [
+    "black",
+    "ruff",
+    "mypy",
+    "pytest",
+    "pandas-stubs",
+    ]
+
+[tool.black]
+line-length = 120
+target-version = ["py311"]
+
+[tool.ruff]
+line-length = 120
+src = ["src"]
+
+[tool.mypy]
+python_version = "3.11"

regenerate_requirements.sh

@@ -0,0 +1,17 @@
+
+#!/bin/bash
+
+set -ex
+
+ADDITIONAL_ARGS=$@
+
+pip-compile \
+    -o requirements.txt \
+    $ADDITIONAL_ARGS \
+    pyproject.toml
+    
+pip-compile \
+    --extra=dev \
+    -o dev-requirements.txt \
+    $ADDITIONAL_ARGS \
+    pyproject.toml

requirements.txt

@@ -0,0 +1,121 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile --output-file=requirements.txt pyproject.toml
+#
+altair==5.0.1
+    # via streamlit
+attrs==23.1.0
+    # via
+    #   jsonschema
+    #   referencing
+blinker==1.6.2
+    # via streamlit
+cachetools==5.3.1
+    # via streamlit
+certifi==2023.7.22
+    # via requests
+charset-normalizer==3.2.0
+    # via requests
+click==8.1.6
+    # via streamlit
+gitdb==4.0.10
+    # via gitpython
+gitpython==3.1.32
+    # via streamlit
+idna==3.4
+    # via requests
+importlib-metadata==6.8.0
+    # via streamlit
+jinja2==3.1.2
+    # via
+    #   altair
+    #   pydeck
+jsonschema==4.19.0
+    # via altair
+jsonschema-specifications==2023.7.1
+    # via jsonschema
+markdown-it-py==3.0.0
+    # via rich
+markupsafe==2.1.3
+    # via jinja2
+mdurl==0.1.2
+    # via markdown-it-py
+numpy==1.25.2
+    # via
+    #   altair
+    #   pandas
+    #   pyarrow
+    #   pydeck
+    #   streamlit
+    #   streamlit-template (pyproject.toml)
+packaging==23.1
+    # via streamlit
+pandas==2.0.3
+    # via
+    #   altair
+    #   streamlit
+    #   streamlit-template (pyproject.toml)
+pillow==9.5.0
+    # via streamlit
+protobuf==4.24.0
+    # via streamlit
+pyarrow==12.0.1
+    # via streamlit
+pydeck==0.8.0
+    # via streamlit
+pygments==2.16.1
+    # via rich
+pympler==1.0.1
+    # via streamlit
+python-dateutil==2.8.2
+    # via
+    #   pandas
+    #   streamlit
+pytz==2023.3
+    # via pandas
+pytz-deprecation-shim==0.1.0.post0
+    # via tzlocal
+referencing==0.30.2
+    # via
+    #   jsonschema
+    #   jsonschema-specifications
+requests==2.31.0
+    # via streamlit
+rich==13.5.2
+    # via streamlit
+rpds-py==0.9.2
+    # via
+    #   jsonschema
+    #   referencing
+six==1.16.0
+    # via python-dateutil
+smmap==5.0.0
+    # via gitdb
+streamlit==1.25.0
+    # via streamlit-template (pyproject.toml)
+tenacity==8.2.3
+    # via streamlit
+toml==0.10.2
+    # via streamlit
+toolz==0.12.0
+    # via altair
+tornado==6.3.3
+    # via streamlit
+typing-extensions==4.7.1
+    # via streamlit
+tzdata==2023.3
+    # via
+    #   pandas
+    #   pytz-deprecation-shim
+tzlocal==4.3.1
+    # via streamlit
+urllib3==2.0.4
+    # via requests
+validators==0.21.2
+    # via streamlit
+watchdog==3.0.0
+    # via streamlit
+zipp==3.16.2
+    # via importlib-metadata

src/start.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+streamlit run streamlit_app.py --server.port=8501 --server.address=0.0.0.0

src/streamlit_app.py

@@ -0,0 +1,36 @@
+import streamlit as st
+import pandas as pd
+import numpy as np
+
+st.title("Uber pickups in NYC")
+
+DATE_COLUMN = "date/time"
+DATA_URL = "https://s3-us-west-2.amazonaws.com/" "streamlit-demo-data/uber-raw-data-sep14.csv.gz"
+
+
+@st.cache_data
+def load_data(nrows):
+    data = pd.read_csv(DATA_URL, nrows=nrows)
+    data.columns = data.columns.str.lower()
+    data[DATE_COLUMN] = pd.to_datetime(data[DATE_COLUMN])
+    return data
+
+
+data_load_state = st.text("Loading data...")
+data = load_data(10000)
+data_load_state.text("Done! (using st.cache_data)")
+
+if st.checkbox("Show raw data"):
+    st.subheader("Raw data")
+    st.write(data)
+
+st.subheader("Number of pickups by hour")
+hist_values = np.histogram(data[DATE_COLUMN].dt.hour, bins=24, range=(0, 24))[0]
+st.bar_chart(hist_values)
+
+# Some number in the range 0-23
+hour_to_filter = st.slider("hour", 0, 23, 17)
+filtered_data = data[data[DATE_COLUMN].dt.hour == hour_to_filter]
+
+st.subheader("Map of all pickups at %s:00" % hour_to_filter)
+st.map(filtered_data)

tests/run_tests.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+# Arguments for each test
+BLACK_ARGS="--check"
+RUFF_ARGS="check"
+MYPY_ARGS=""
+PYTEST_ARGS=""
+
+# Use -f for 
+while getopts 'f' OPTION; do
+  case "$OPTION" in
+    f)
+      echo "Fix mode"
+      BLACK_ARGS=""
+      RUFF_ARGS+=" --fix"
+      ;;
+  esac
+done
+shift "$(($OPTIND -1))"
+
+testheader () {
+    echo -e '\n'
+    echo "*"$emptyvar{1..20}
+    echo $1
+    echo "*"$emptyvar{1..20}
+}
+
+APPDIR=/app/src
+TESTSDIR=/app/tests
+
+testheader "black"
+black $BLACK_ARGS $APPDIR $TESTSDIR
+
+testheader "ruff"
+ruff $RUFF_ARGS $APPDIR $TESTSDIR
+
+testheader "mypy"
+mypy $MYPY_ARGS $APPDIR $TESTSDIR
+
+testheader "pytest"
+pytest $PYTEST_ARGS $TESTSDIR/unit

tests/unit/test_empty_example.py

@@ -0,0 +1,2 @@
+def test_nothing():
+    pass