Merge 'upstream/master' into jy-update-html-df-item-2.3

Author: jyaistMap

.github/workflows/DockerBuild.AzureFunctionsBaseImage.yaml

@@ -0,0 +1,73 @@
+name: DockerBuild.AzureFunctionsImage
+
+permissions:
+  contents: read
+  packages: write
+
+on:
+  # allow it to be run on-demand
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version of ArcGIS API for Python to install in the image"
+        type: string
+        default: "2.3.1"
+      python_version:
+        description: "Python version to base image on"
+        type: string
+        default: "3.11"
+      is_latest_release:
+        description: "Version of ArcGIS API for Python is Latest current release"
+        type: boolean
+        default: false
+      is_default_supported_python:
+        description: "Python version is default supported version (i.e. python used by Pro and Enterprise)"
+        type: boolean
+        default: false
+
+jobs:
+  build-and-push:
+    name: Build Docker image and push to ghcr.io
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Github Packages
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ghcr.io/esri/arcgis-python-api-azure-functions
+          tags: |
+            type=raw,value=${{ inputs.version }}-python${{ inputs.python_version }}
+            type=raw,value=${{ inputs.version }},enable=${{ inputs.is_default_supported_python && github.ref_name == github.event.repository.default_branch }}
+            type=raw,value=latest,enable=${{ inputs.is_latest_release && inputs.is_default_supported_python && github.ref_name == github.event.repository.default_branch }}
+            type=schedule,pattern={{date 'YY.MM'}},enable=${{ inputs.is_latest_release && inputs.is_default_supported_python && github.ref_name == github.event.repository.default_branch }}
+
+      - id: docker_build
+        name: Build image and push to GitHub Container Registry
+        uses: docker/build-push-action@v6
+        with:
+          # relative path to the place where source code with Dockerfile is located
+          context: .
+          file: ./docker/AzureFunctionsBaseImage.Dockerfile
+          build-args: |
+            python_version=${{ inputs.python_version }}
+            arcgis_version=${{ inputs.version }}
+          tags: ${{ steps.meta.outputs.tags }}
+          provenance: false
+          platforms: linux/amd64
+          push: true

.github/workflows/DockerBuild.LambdaBaseImage.yaml

@@ -1,13 +1,17 @@
 name: DockerBuild.LambdaImage
 
+permissions:
+  contents: read
+  packages: write
+
 on:
   # allow it to be run on-demand
   workflow_dispatch:
     inputs:
       version:
         description: "Version of ArcGIS API for Python to install in the image"
         type: string
-        default: "2.3.0"
+        default: "2.3.1"
       python_version:
         description: "Python version to base image on"
         type: string
@@ -28,22 +32,22 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Login to Github Packages
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: |
             ghcr.io/esri/arcgis-python-api-lambda
@@ -55,7 +59,7 @@ jobs:
 
       - id: docker_build
         name: Build image and push to GitHub Container Registry
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           # relative path to the place where source code with Dockerfile is located
           context: .

.github/workflows/DockerBuild.NotebookImage.yaml

@@ -1,17 +1,21 @@
 name: DockerBuild.NotebookImage
 
+permissions:
+  contents: read
+  packages: write
+
 on:
   # allow it to be run on-demand
   workflow_dispatch:
     inputs:
       version:
         description: "Version of ArcGIS API for Python to install in the image"
         type: string
-        default: "2.2.0"
+        default: "2.3.1"
       python_version:
         description: "Python version to base image on"
         type: string
-        default: "3.9"
+        default: "3.11"
       is_latest_release:
         description: "Version of ArcGIS API for Python is Latest current release"
         type: boolean
@@ -32,18 +36,18 @@ jobs:
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Login to Github Packages
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: |
             ghcr.io/esri/arcgis-python-api-notebook
@@ -55,7 +59,7 @@ jobs:
 
       - id: docker_build
         name: Build image and push to GitHub Container Registry
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           # relative path to the place where source code with Dockerfile is located
           context: ./docker

docker/AzureFunctionsBaseImage.Dockerfile

@@ -0,0 +1,17 @@
+ARG python_version=3.11
+# azure-functions python image, defaults to python 3.11
+FROM mcr.microsoft.com/azure-functions/python:4-python${python_version}
+
+# set metadata
+LABEL org.opencontainers.image.authors="[email protected]"
+LABEL org.opencontainers.image.description="Azure Functions image with arcgis Python API and its Linux dependencies preinstalled"
+LABEL org.opencontainers.image.licenses=Apache
+LABEL org.opencontainers.image.source=https://github.com/esri/arcgis-python-api
+
+# install dependencies, then clean yum cache
+RUN apt-get update && apt-get install -y gcc libkrb5-dev krb5-config krb5-user && apt-get clean && rm -rf /var/lib/apt/lists/*
+RUN pip3 install azure-functions && rm -rf /home/.cache/pip
+# install arcgis
+ARG arcgis_version="2.3.1"
+# adding .* ensures the latest patch version is installed
+RUN  pip3 install "arcgis==${arcgis_version}.*" && rm -rf /home/.cache/pip

docker/LambdaBaseImage.Dockerfile

@@ -11,7 +11,7 @@ LABEL org.opencontainers.image.source=https://github.com/esri/arcgis-python-api
 # install dependencies, then clean yum cache
 RUN yum -y install gcc gcc-c++ krb5-devel krb5-server krb5-libs && yum clean all && rm -rf /var/cache/yum
 # install arcgis
-ARG arcgis_version="2.3.0"
+ARG arcgis_version="2.3.1"
 # adding .* ensures the latest patch version is installed
 RUN  pip3 install "arcgis==${arcgis_version}.*" --target "${LAMBDA_TASK_ROOT}" && rm -rf /root/.cache/pip
 # set entrypoint to app.py handler method

docker/NotebookImage.Dockerfile

@@ -1,30 +1,31 @@
-ARG python_version="3.9"
-FROM jupyter/base-notebook:python-${python_version}
+ARG python_version="3.11"
+FROM quay.io/jupyter/minimal-notebook:python-${python_version}
 
 ARG python_version
-ARG arcgis_version="2.2.0"
+ARG arcgis_version="2.4.0"
 ARG sampleslink="https://github.com/Esri/arcgis-python-api/releases/download/v${arcgis_version}/samples.zip"
 ARG githubfolder="arcgis-python-api"
-ENV DOCKER_STACKS_JUPYTER_CMD="notebook"
+ARG env_name=arcgis
 
 LABEL org.opencontainers.image.authors="[email protected]"
-LABEL org.opencontainers.image.description="Jupyter Notebook with the latest version of the ArcGIS API for Python and its Linux dependencies preinstalled"
+LABEL org.opencontainers.image.description="Jupyter environment preconfigured for ArcGIS API for Python"
 LABEL org.opencontainers.image.licenses=Apache
 LABEL org.opencontainers.image.source=https://github.com/Esri/arcgis-python-api
 
-USER root
-
-RUN apt-get update --yes && \
-    apt-get install --yes --no-install-recommends unzip && \
-    apt-get clean && rm -rf /var/lib/apt/lists/*
-
 USER ${NB_UID}
 
 # Install Python API from Conda
-RUN conda install -c esri arcgis=${arcgis_version} -y \
+RUN conda create -n ${env_name} -c esri -c defaults arcgis=${arcgis_version} python=${python_version} -y --quiet --override-channels \
     && conda clean --all -f -y \
     && find /opt/conda -name __pycache__ -type d -exec rm -rf {} +
 
+# Install arcgis-mapping if arcgis_version >= 2.4.0
+RUN (dpkg --compare-versions $arcgis_version ge 2.4.0 \
+    && conda install -n ${env_name} -c esri -c defaults arcgis-mapping -y --quiet --override-channels \
+    && conda clean --all -f -y \
+    && find /opt/conda -name __pycache__ -type d -exec rm -rf {} +;) \
+    || echo "[INFO] Skipped installing arcgis-mapping for version $arcgis_version (>= 2.4.0 required for arcgis-mapping)"
+
 # Fetch and extract samples from GitHub
 RUN mkdir /home/${NB_USER}/$githubfolder && \
     wget -O samples.zip $sampleslink \
@@ -36,7 +37,34 @@ RUN mkdir /home/${NB_USER}/$githubfolder && \
            work/ \
            talks/ \
            environment.yml\
+    # remove .DS_Store and __MACOSX from home directory:
+    && find /home/${NB_USER} -name ".DS_Store" -delete \
+    && rm -rf /home/${NB_USER}/__MACOSX \
     && fix-permissions /home/${NB_USER}
 
-RUN rm /opt/conda/lib/python${python_version}/site-packages/notebook/static/base/images/logo.png
-COPY --chown=${NB_USER}:users jupyter_esri_logo.png /opt/conda/lib/python${python_version}/site-packages/notebook/static/base/images/logo.png
+# See https://jupyter-docker-stacks.readthedocs.io/en/latest/using/recipes.html#add-a-custom-conda-environment-and-jupyter-kernel
+# Create Python kernel and link it to jupyter
+RUN "${CONDA_DIR}/envs/${env_name}/bin/python" -m ipykernel install --user --name="${env_name}" && \
+    fix-permissions "${CONDA_DIR}" && \
+    fix-permissions "/home/${NB_USER}"
+
+
+# More information here: https://github.com/jupyter/docker-stacks/pull/2047
+USER root
+
+# Set DOCKER_STACKS_JUPYTER_CMD to "notebook" for versions less than 2.4.0
+RUN \
+    (dpkg --compare-versions $arcgis_version lt 2.4.0 \
+    && echo 'DOCKER_STACKS_JUPYTER_CMD="notebook"' >> /etc/environment \
+    && echo "[INFO] Set DOCKER_STACKS_JUPYTER_CMD to notebook for arcgis < 2.4.0") \
+    || echo "[INFO] Using default DOCKER_STACKS_JUPYTER_CMD (lab) for arcgis >= 2.4.0"
+
+RUN \
+    # This changes a startup hook, which will activate the custom environment for the process
+    echo conda activate "${env_name}" >> /usr/local/bin/before-notebook.d/10activate-conda-env.sh && \
+    # This makes the custom environment default in Jupyter Terminals for all users which might be created later
+    echo conda activate "${env_name}" >> /etc/skel/.bashrc && \
+    # This makes the custom environment default in Jupyter Terminals for already existing NB_USER
+    echo conda activate "${env_name}" >> "/home/${NB_USER}/.bashrc"
+
+USER ${NB_UID}

docker/README.md

@@ -8,7 +8,7 @@ Some useful docker images for utilizing the ArcGIS API for Python in your workfl
 
 To use this image, setup your dockerfile like:
 ```
-FROM ghcr.io/esri/arcgis-python-api-lambda
+FROM ghcr.io/esri/arcgis-python-api-lambda:latest
 COPY app.py ${LAMBDA_TASK_ROOT}
 ```
 
@@ -24,3 +24,39 @@ def handler(event, context):
 ```
 
 Push to your _private_ AWS ECR instance, and configure lambda to run from this container image.  As of this writing, public AWS ECR instances are not supported for lambda.
+
+## AzureFunctionsBaseImage
+
+#### ghcr.io/esri/arcgis-python-api-azure-functions:latest
+
+[Sample](samples/AzureFunctions)
+
+To use this image, setup your dockerfile like
+```
+FROM ghcr.io/esri/arcgis-python-api-azure-functions:latest
+COPY . /home/site/wwwroot
+```
+
+Your copied resources will need to include:
+- `host.json`, with your appsettings
+- `function_app.py`, such as:
+
+```
+import arcgis
+import azure.functions as func
+
+app = func.FunctionApp()
+
+@app.http_trigger(route='GET /', methods=['get'])
+def main(req: func.HttpRequest) -> func.HttpResponse:
+    return func.HttpResponse(f"Hello from Azure Functions using ArcGIS API for Python {arcgis.__version__}!")
+```
+
+Push to the container registry of your choice.
+
+For futher information, see:
+
+- https://learn.microsoft.com/en-us/azure/azure-functions/functions-reference-python?tabs=asgi%2Capplication-level&pivots=python-mode-decorators#programming-model
+- https://learn.microsoft.com/en-us/azure/azure-functions/functions-deploy-container-apps?tabs=acr%2Cbash&pivots=programming-language-python#create-and-test-the-local-functions-project
+- https://github.com/Azure/azure-functions-python-worker
+- https://learn.microsoft.com/en-us/azure/azure-functions/functions-how-to-custom-container

docker/samples/AzureFunctions/.dockerignore

@@ -0,0 +1 @@
+local.settings.json

docker/samples/AzureFunctions/.gitignore

@@ -0,0 +1,48 @@
+bin
+obj
+csx
+.vs
+edge
+Publish
+
+*.user
+*.suo
+*.cscfg
+*.Cache
+project.lock.json
+
+/packages
+/TestResults
+
+/tools/NuGet.exe
+/App_Data
+/secrets
+/data
+.secrets
+appsettings.json
+local.settings.json
+
+node_modules
+dist
+
+# Local python packages
+.python_packages/
+
+# Python Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Azurite artifacts
+__blobstorage__
+__queuestorage__
+__azurite_db*__.json