Skip to content
This repository has been archived by the owner on Sep 18, 2024. It is now read-only.

Commit

Permalink
[Issue #184] Pin Python version to 3.12 + dependency updates (#185)
Browse files Browse the repository at this point in the history
## Summary
Fixes #184

### Time to review: __5 mins__

## Changes proposed
Pin the Python version and document details on how to upgrade

Upgraded packages as well while I was tinkering with this

## Context for reviewers
This is mirroring changes from the template repo:
navapbc/template-application-flask#235

Python releases new minor versions (3.12, 3.13, etc.) every year in
October. It usually takes a few weeks for all of our dependencies and
tooling to also be upgraded to the latest version, causing our builds to
break. There isn't much we can do except wait a few weeks and then do
the upgrade (assuming no breaking changes in features we use).

However, we had some of our dependencies pinned to the major version
(Python 3) so it has broken the past few years until it started working
again when the dependencies got fixed. This is just getting ahead of
that and making sure the upgrade to Python 3.13 doesn't cause any
problems.

## Additional information
This change is largely documentation as the Python version used in the
dockerfile + pyproject.toml already would have resolved to Python 3.12,
this just makes it so it won't auto-upgrade to 3.13 when that releases
in October.

The package updates are all very minor - we updated them not too long
ago, mostly just cleaning up a few things like the types-requests issue
that is no longer present.
  • Loading branch information
chouinar authored Aug 28, 2024
1 parent 7f7103d commit 2b23dd4
Show file tree
Hide file tree
Showing 5 changed files with 496 additions and 449 deletions.
4 changes: 3 additions & 1 deletion api/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
# The build stage that will be used to deploy to the various environments
# needs to be called `release` in order to integrate with the repo's
# top-level Makefile
FROM python:3-slim AS base
FROM python:3.12-slim AS base
# See /documentation/api/package-depedency-management.md#Upgrading Python
# for details on upgrading your Python version

# Install poetry, the package manager.
# https://python-poetry.org
Expand Down
2 changes: 1 addition & 1 deletion api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ See [development.md](../documentation/api/development.md) for installation and d
* [Formatting and Linting](../documentation/api/formatting-and-linting.md)
* [Writing Tests](../documentation/api/writing-tests.md)
* [Logging configuration](../documentation/api/monitoring-and-observability/logging-configuration.md)
* [Loggin conventions](../documentation/api/monitoring-and-observability/logging-conventions.md)
* [Logging conventions](../documentation/api/monitoring-and-observability/logging-conventions.md)
Loading

0 comments on commit 2b23dd4

Please sign in to comment.