Merge branch 'master' into NA/guides_11

Author: nanaeaubry

docker/NotebookImage.Dockerfile

@@ -1,30 +1,31 @@
 ARG python_version="3.11"
-FROM quay.io/jupyter/base-notebook:python-${python_version}
+FROM quay.io/jupyter/minimal-notebook:python-${python_version}
 
 ARG python_version
-ARG arcgis_version="2.3.1"
+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}

guide/02-api-overview/deprecation-notices.ipynb

@@ -28,6 +28,7 @@
     "- `Swipe.edit` - deprecated in **2.4.0** removed in future major release. Use the `content` property setter instead.\n",
     "- `MapAction` - deprecated in **2.4.0** removed in future major release. Use the `MediaAction` class instead.\n",
     "- `JournalStoryMap` - deprecated in **2.0.0** removed in **2.4.0**.  Template was removed from the ArcGIS platform.\n",
+    "- `Hub.initiatives` - deprecated in **2.4.0** removed in a future release. Use `Hub.sites` instead.\n",
     "\n",
     "\n",
     "### `arcgis.learn` Module\n",
@@ -189,7 +190,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.14"
+   "version": "3.11.5"
   }
  },
  "nbformat": 4,

guide/03-the-gis/managing-your-gis-servers.ipynb

@@ -48,7 +48,7 @@
     "\n",
     "import pandas as pd\n",
     "\n",
-    "from arcgis.gis import GIS"
+    "from arcgis.gis import GIS, ItemTypeEnum, ItemProperties"
    ]
   },
   {
@@ -466,7 +466,19 @@
     }
    ],
    "source": [
-    "gis.content.add({}, output_dir + out_file)"
+    "root_folder = gis.content.folders.get()\n",
+    "\n",
+    "new_item_props = ItemProperties(\n",
+    "    \"title\":out_file,\n",
+    "    \"type\":ItemTypeEnum.CSV.value,\n",
+    "    \"tags\":\"item_metatdata_report\",\n",
+    "    \"snippet\":\"Report on item attributes from API\"\n",
+    ")\n",
+    "\n",
+    "root_folder.add(\n",
+    "    item_properties=new_item_props,\n",
+    "    file=os.path.join(output_dir + out_file)\n",
+    ").result()"
    ]
   },
   {
@@ -516,7 +528,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.16"
+   "version": "3.11.0"
   },
   "toc": {
    "base_numbering": 1,
@@ -533,5 +545,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

guide/10-mapping-and-visualization/part2_navigating_the_map_widget.ipynb

@@ -44,7 +44,7 @@
     "\n",
     "import pandas as pd\n",
     "\n",
-    "from arcgis.gis import GIS"
+    "from arcgis.gis import GIS, ItemPropertie, ItemTypeEnum"
    ]
   },
   {
@@ -281,7 +281,19 @@
     }
    ],
    "source": [
-    "gis.content.add({}, output_dir + out_file)"
+    "item_props = ItemProperties(\n",
+    "    \"title\" = out_file,\n",
+    "    \"type\" = ItemTypeEnum.CSV,\n",
+    "    \"tags\" = \"user_profile_report\",\n",
+    "    \"snippet\" = \"Report on user profile data from Python API\"\n",
+    ")\n",
+    "\n",
+    "root_folder = gis.content.folders.get()\n",
+    "\n",
+    "gis.content.add(\n",
+    "    item_properties = item_props,\n",
+    "    file= os.path.join(output_dir + out_file)\n",
+    ").result()"
    ]
   },
   {
@@ -331,7 +343,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.16"
+   "version": "3.11.0"
   },
   "toc": {
    "base_numbering": 1,
@@ -348,5 +360,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

samples/03_org_administrators/validate_item_metadata.ipynb

@@ -374,7 +374,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "`arcgis.learn` provides the MaskRCNN model for instance segmentation tasks, which is based on a pretrained convnet, like ResNet that acts as the 'backbone'. More details about MaskRCNN can be found [here](https://github.com/Esri/arcgis-python-api/blob/master/guide/14-deep-learning/How_MaskRCNN_works.ipynb)."
+    "`arcgis.learn` provides the MaskRCNN model for instance segmentation tasks, which is based on a pretrained convnet, like ResNet that acts as the 'backbone'. More details about MaskRCNN can be found [here](https://github.com/Esri/arcgis-python-api/blob/master/guide/14-deep-learning/how_maskrcnn_works.ipynb)."
    ]
   },
   {