[CIVIS-2326] ENH update base datascience-python image to 7.3.0 (#54)

* ENH update base ds-py image to 7.3.0

* TST check that .ds_python_version and Dockerfile match for ds-py image version

* TST clearer test message

* MAINT update changelog

.circleci/config.yml

@@ -2,10 +2,24 @@ version: 2
 jobs:
   build:
     docker:
-      - image: cimg/python:3.11
+      - image: cimg/python:3.12
     steps:
       - checkout
       - setup_remote_docker
+      - run:
+          name: Check that .ds_python_version and Dockerfile are consistent
+          command: |
+            python -u << HERE
+            import re
+            v1 = re.search(r"(\d+\.\d+.\d+)", open(".ds_python_version").read()).group(1)
+            v2 = re.search(r"ARG DS_PYTHON_IMG_VERSION\=(\d+\.\d+.\d+)", open("Dockerfile").read()).group(1)
+            if v1 == v2:
+                print(f".ds_python_version and Dockerfile match for the ds-py image version: {v1}")
+            else:
+                raise ValueError(
+                    f".ds_python_version and Dockerfile don't match for the ds-py image version: {v1} and {v2}"
+                )
+            HERE
       - run:
           name: "Get civisanalytics/datascience-python image version"
           command: echo 'export DS_PYTHON_IMG_VERSION="$(head -n 1 ./.ds_python_version)"' >> "$BASH_ENV"

.ds_python_version

@@ -1 +1 @@
-7.0.0
+7.3.0

.github/ISSUE_TEMPLATE/general.md

@@ -0,0 +1,11 @@
+---
+name: General
+about: Ask a question, report a potential issue, etc.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Note:** Civis employees should _not_ use the GitHub Issues feature at this public codebase
+to file a ticket, and should instead use the internal ticketing system.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+
+
+---
+
+- [ ] (For Civis employees only) Reference to a relevant ticket in the pull request title
+- [ ] Changelog entry added to `CHANGELOG.md` at the repo's root level
+- [ ] Description of change in the pull request description
+- [ ] If applicable, unit tests have been added and/or updated
+- [ ] The CircleCI builds have all passed

CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+## [3.1.0] - 2024-06-18
+### Changed
+- Updated base datascience-python image version to v7.3.0 (#54)
+- Updated core Python dependency versions (#54):
+    * civis-jupyter-notebook 2.1.1 -> 2.2.0
+    * matplotlib 3.7.2 -> 3.9.0
+    * seaborn 0.12.2 -> 0.13.2
+
 ## [3.0.0] - 2023-08-22
 ### Changed
 - update base datascience-python version to v7.0.0 (#50)

Dockerfile

@@ -2,7 +2,7 @@
 # Unfortunately Dockerhub isn't as flexible as CircleCi or AWS Codebuild, so we have to hardcode this value here.
 # So if you in the future need to update this value, make sure you also edit the value in .ds_python_version.
 # These values should be kept in sync.
-ARG DS_PYTHON_IMG_VERSION=7.0.0
+ARG DS_PYTHON_IMG_VERSION=7.3.0
 
 FROM civisanalytics/datascience-python:${DS_PYTHON_IMG_VERSION}
 
@@ -33,8 +33,7 @@ RUN chmod +x /tini
 
 COPY requirements-full.txt .
 
-RUN pip install -r requirements-full.txt && \
-    pip cache purge && \
+RUN pip install --progress-bar off --no-cache-dir -r requirements-full.txt && \
     rm requirements-full.txt && \
     civis-jupyter-notebooks-install
 

README.md

@@ -1,5 +1,5 @@
 # Civis Jupyter Notebook Docker Image for Python 3
-[![CircleCI](https://circleci.com/gh/civisanalytics/civis-jupyter-python3/tree/master.svg?style=svg)](https://circleci.com/gh/civisanalytics/civis-jupyter-python3/tree/master)
+[![CircleCI](https://circleci.com/gh/civisanalytics/civis-jupyter-python3/tree/master.svg?style=shield)](https://circleci.com/gh/civisanalytics/civis-jupyter-python3/tree/master)
 
 ## Installation
 
@@ -24,7 +24,7 @@ The version number has been pulled out into a dedicated file to centralize consu
 
 To update the version simply change the version number in `.ds_python_version`
 
-## Testing Integration with the Civis Platform
+## Testing Integration with Civis Platform
 
 If you would like to test the image locally follow the steps below:
 
@@ -46,10 +46,29 @@ and describe any changes in the [change log](CHANGELOG.md).
 
 ### For Maintainers
 
+#### Updating Dependencies
+
+Updating the `civis-jupyter-python3` Docker image entails the following:
+
+* Update the base `datascience-python` image to the latest one;
+* Update `requirements-core.txt`, the Python dependencies specific to this `civis-jupyter-python3` image.
+* Update `requirements-full.txt` so that it has all transitive dependencies pinned
+  while respecting those already pinned at both `datascience-python` and `requirements-core.txt`.
+
+To execute these updates, follow these steps:
+
+* Update the version number of the `datascience-python` image in both `Dockerfile` and `.ds_python_version`.
+* Update the Python dependencies in `requirements-core.txt` as necessary.
+* Locally, have Docker Desktop running in prep for the next step.
+* Run `sh generate-requirements-full.sh` to update `requirements-full.txt`.
+* To verify the new `civis-jupyter-python3` image would successfully build with your changes, locally run `sh build_docker_file.sh`.
+
+#### Making a New Releases
+
 This repo has autobuild enabled. Any PR that is merged to master will
 be built as the `latest` tag on Dockerhub.
 Once you are ready to create a new version, go to the "releases" tab of the repository and click
-"Draft a new release". Github will prompt you to create a new tag, release title, and release
+"Draft a new release". GitHub will prompt you to create a new tag, release title, and release
 description. The tag should use semantic versioning in the form "vX.X.X"; "major.minor.micro".
 The title of the release should be the same as the tag. Include a change log in the release description.
 Once the release is tagged, DockerHub will automatically build three identical containers, with labels
@@ -59,4 +78,4 @@ Once the release is tagged, DockerHub will automatically build three identical c
 
 BSD-3
 
-See [LICENSE.md](LICENSE.md) for details.
+See [LICENSE.txt](LICENSE.txt) for details.

generate-requirements-full.sh

@@ -7,4 +7,4 @@ docker run \
     "pip freeze >> /tmp/requirements-aggregated-core.txt && \
     cat /src/requirements-core.txt >> /tmp/requirements-aggregated-core.txt && \
     pip install pip-tools && \
-    pip-compile --output-file=/src/requirements-full.txt --pip-args='--prefer-binary' /tmp/requirements-aggregated-core.txt"
+    pip-compile --output-file=/src/requirements-full.txt --pip-args='--prefer-binary' --upgrade /tmp/requirements-aggregated-core.txt"

requirements-core.txt

@@ -1,3 +1,3 @@
-matplotlib==3.7.2
-seaborn==0.12.2
-civis-jupyter-notebook==2.1.1
+civis-jupyter-notebook==2.2.0
+matplotlib==3.9.0
+seaborn==0.13.2