Python 3.13 support, drop Python 3.8 support (#12)

* Initialize template from version f4840f3f2382a912a6730a6520061e4fcc274ca1 * Update template to version 072543e27d8b506a6628f7793798609c62d6a8ae * lock requirements * Bump version * fix notes * fix tests
AmbitionEng · Nov 2, 2024 · 65c0e68 · 65c0e68
1 parent f08fd63
commit 65c0e68
Show file tree

Hide file tree

Showing 13 changed files with 1,050 additions and 265 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -6,7 +6,7 @@ orbs:
       python:
         working_directory: /code
         docker:
-          - image: opus10/circleci-python-library:2024-04-17
+          - image: opus10/circleci-python-library:2024-10-26
             environment:
               # Ensure makefile commands are not wrapped in "docker compose run"
               EXEC_WRAPPER: ''
@@ -15,11 +15,11 @@ orbs:
         steps:
           - checkout
           - restore_cache:
-              key: v4-{{ checksum "poetry.lock" }} 
+              key: v5-{{ checksum "poetry.lock" }}
           - run: make dependencies
           - run: make full-test-suite
           - save_cache:
-              key: v4-{{ checksum "poetry.lock" }} 
+              key: v5-{{ checksum "poetry.lock" }}
               paths:
                 - /home/circleci/.cache/pypoetry/
                 - /code/.venv
@@ -37,7 +37,7 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          key: v4-{{ checksum "poetry.lock" }} 
+          key: v5-{{ checksum "poetry.lock" }}
       - run: make dependencies
       - run: make lint
 
@@ -46,7 +46,7 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          key: v4-{{ checksum "poetry.lock" }}
+          key: v5-{{ checksum "poetry.lock" }}
       - run: make dependencies
       - run: make type-check || true
 
@@ -55,9 +55,8 @@ jobs:
     steps:
       - checkout
       - run: ssh-add -D
-      - run: echo "${GITHUB_DEVOPS_PRIVATE_SSH_KEY_BASE64}" | base64 --decode | ssh-add - > /dev/null
       - restore_cache:
-          key: v4-{{ checksum "poetry.lock" }} 
+          key: v5-{{ checksum "poetry.lock" }}
       - run: make dependencies
       - run: poetry run python devops.py deploy
 

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -2,10 +2,11 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.9"
 mkdocs:
   configuration: mkdocs.yml
   fail_on_warning: false
+formats: all
 python:
   install:
   - requirements: docs/requirements.txt
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,16 @@
 # Changelog
 
+## 1.0.0 (2024-11-01)
+
+#### Changes
+
+  - Added Python 3.13 support, dropped Python 3.8 support by [@wesleykendall](https://github.com/wesleykendall) in [#12](https://github.com/Opus10/footing/pull/12).
+
 ## 0.1.7 (2024-08-24)
 
- #### Changes
+#### Changes
 
-   - Updated docs styling and testing dependencies by [@wesleykendall](https://github.com/wesleykendall) in [#17](https://github.com/Opus10/footing/pull/11).
+  - Updated docs styling and testing dependencies by [@wesleykendall](https://github.com/wesleykendall) in [#11](https://github.com/Opus10/footing/pull/11).
 
 ## 0.1.6 (2024-04-22)
 

diff --git a/Makefile b/Makefile
@@ -6,7 +6,6 @@
 # dependencies - Installs dependencies
 # docs - Build documentation
 # docs-serve - Serve documentation
-# docs-requirements - Build the docs requirements file
 # lint - Run code linting and static checks
 # lint-fix - Fix common linting errors
 # type-check - Run Pyright type-checking
@@ -55,7 +54,6 @@ ifndef run
 	      "    type-check: Run Pyright type-checking\n"\
 	      "    docs: Build documentation\n"\
 	      "    docs-serve: Serve documentation\n"\
-	      "    docs-requirements: Build the docs requirements file\n"\
 	      "    docker-teardown: Spin down docker resources\n"\
 	      "\n"\
 	      "View the Makefile for more documentation"
@@ -76,6 +74,7 @@ docker-start:
 .PHONY: lock
 lock:
 	$(EXEC_WRAPPER) poetry lock --no-update
+	$(EXEC_WRAPPER) poetry export --with dev --without-hashes -f requirements.txt > docs/requirements.txt
 
 
 # Install dependencies
@@ -142,12 +141,6 @@ docs-serve:
 	$(EXEC_WRAPPER) mkdocs serve
 
 
-# Make the docs requirements file
-.PHONY: docs-requirements
-docs-requirements:
-	$(EXEC_WRAPPER) poetry export --with dev --without-hashes -f requirements.txt > docs/requirements.txt
-
-
 # Run code linting and static analysis. Ensure docs can be built
 .PHONY: lint
 lint:

diff --git a/README.md b/README.md
@@ -73,7 +73,7 @@ Similar to `footing update`, you will need to review the changes, resolve confli
 
 ## Compatibility
 
-`footing` is compatible with Python 3.8 - 3.12.
+`footing` is compatible with Python 3.9 - 3.13.
 
 ## Next Steps
 

diff --git a/docs/index.md b/docs/index.md
@@ -84,7 +84,7 @@ Similar to `footing update`, you will need to review the changes, resolve confli
 
 ## Compatibility
 
-`footing` is compatible with Python 3.8 - 3.12.
+`footing` is compatible with Python 3.9 - 3.13.
 
 ## Next Steps
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,77 +1,102 @@
-arrow==1.3.0 ; python_version >= "3.8" and python_version < "4"
-astunparse==1.6.3 ; python_version >= "3.8" and python_version < "3.9"
-babel==2.14.0 ; python_version >= "3.8" and python_version < "4"
-binaryornot==0.4.4 ; python_full_version >= "3.8.0" and python_version < "4"
-black==24.8.0 ; python_version >= "3.8" and python_version < "4"
-cachetools==5.5.0 ; python_version >= "3.8" and python_version < "4"
-certifi==2024.2.2 ; python_version >= "3.8" and python_version < "4"
-chardet==5.2.0 ; python_version >= "3.8" and python_version < "4"
-charset-normalizer==3.3.2 ; python_version >= "3.8" and python_version < "4"
-click==8.1.7 ; python_version >= "3.8" and python_version < "4"
-colorama==0.4.6 ; python_version >= "3.8" and python_version < "4"
-cookiecutter==1.7.3 ; python_full_version >= "3.8.0" and python_version < "4"
-coverage[toml]==7.4.4 ; python_version >= "3.8" and python_version < "4"
-distlib==0.3.8 ; python_version >= "3.8" and python_version < "4"
-exceptiongroup==1.2.1 ; python_version >= "3.8" and python_version < "3.11"
-filelock==3.15.4 ; python_version >= "3.8" and python_version < "4"
-ghp-import==2.1.0 ; python_version >= "3.8" and python_version < "4"
-griffe==1.2.0 ; python_version >= "3.8" and python_version < "4"
-idna==3.7 ; python_version >= "3.8" and python_version < "4"
-importlib-metadata==7.1.0 ; python_version >= "3.8" and python_version < "3.10"
-iniconfig==2.0.0 ; python_version >= "3.8" and python_version < "4"
-jinja2-time==0.2.0 ; python_full_version >= "3.8.0" and python_version < "4"
-jinja2==3.1.3 ; python_version >= "3.8" and python_version < "4"
-markdown==3.6 ; python_version >= "3.8" and python_version < "4"
-markupsafe==2.1.5 ; python_version >= "3.8" and python_version < "4"
-mergedeep==1.3.4 ; python_version >= "3.8" and python_version < "4"
-mkdocs-autorefs==1.0.1 ; python_version >= "3.8" and python_version < "4"
-mkdocs-get-deps==0.2.0 ; python_version >= "3.8" and python_version < "4"
-mkdocs-material-extensions==1.3.1 ; python_version >= "3.8" and python_version < "4"
-mkdocs-material==9.5.33 ; python_version >= "3.8" and python_version < "4"
-mkdocs==1.6.0 ; python_version >= "3.8" and python_version < "4"
-mkdocstrings-python==1.10.8 ; python_version >= "3.8" and python_version < "4"
-mkdocstrings==0.25.2 ; python_version >= "3.8" and python_version < "4"
-mypy-extensions==1.0.0 ; python_version >= "3.8" and python_version < "4"
-nodeenv==1.8.0 ; python_full_version >= "3.8.0" and python_version < "4"
-packaging==24.1 ; python_version >= "3.8" and python_version < "4"
-paginate==0.5.6 ; python_version >= "3.8" and python_version < "4"
-pathspec==0.12.1 ; python_version >= "3.8" and python_version < "4"
-platformdirs==4.2.2 ; python_version >= "3.8" and python_version < "4"
-pluggy==1.5.0 ; python_version >= "3.8" and python_version < "4"
-poetry-core==1.9.0 ; python_version >= "3.8" and python_version < "4.0"
-poyo==0.5.0 ; python_full_version >= "3.8.0" and python_version < "4"
-pyfakefs==5.4.1 ; python_full_version >= "3.8.0" and python_version < "4"
-pygments==2.17.2 ; python_version >= "3.8" and python_version < "4"
-pymdown-extensions==10.8 ; python_version >= "3.8" and python_version < "4"
-pyproject-api==1.7.1 ; python_version >= "3.8" and python_version < "4"
-pyright==1.1.377 ; python_full_version >= "3.8.0" and python_version < "4"
-pytest-cov==5.0.0 ; python_version >= "3.8" and python_version < "4"
-pytest-dotenv==0.5.2 ; python_full_version >= "3.8.0" and python_version < "4"
-pytest-mock==3.14.0 ; python_version >= "3.8" and python_version < "4"
-pytest==8.3.2 ; python_version >= "3.8" and python_version < "4"
-python-dateutil==2.9.0.post0 ; python_version >= "3.8" and python_version < "4"
-python-dotenv==1.0.1 ; python_version >= "3.8" and python_version < "4"
-python-gitlab==4.4.0 ; python_full_version >= "3.8.0" and python_version < "4"
-python-slugify==8.0.4 ; python_full_version >= "3.8.0" and python_version < "4"
-pytz==2024.1 ; python_version >= "3.8" and python_version < "3.9"
-pyyaml-env-tag==0.1 ; python_version >= "3.8" and python_version < "4"
-pyyaml==5.3.1 ; python_version >= "3.8" and python_version < "4"
-regex==2024.4.16 ; python_version >= "3.8" and python_version < "4"
-requests-file==2.0.0 ; python_version >= "3.8" and python_version < "4"
-requests-toolbelt==1.0.0 ; python_full_version >= "3.8.0" and python_version < "4"
-requests==2.31.0 ; python_version >= "3.8" and python_version < "4"
-responses==0.25.0 ; python_version >= "3.8" and python_version < "4"
-ruff==0.6.2 ; python_full_version >= "3.8.0" and python_version < "4"
-setuptools==69.5.1 ; python_version >= "3.8" and python_version < "4"
-six==1.16.0 ; python_version >= "3.8" and python_version < "4"
-text-unidecode==1.3 ; python_full_version >= "3.8.0" and python_version < "4"
-tldextract==5.1.2 ; python_version >= "3.8" and python_version < "4"
-tomli==2.0.1 ; python_version >= "3.8" and python_full_version <= "3.11.0a6"
-tox==4.18.0 ; python_version >= "3.8" and python_version < "4"
-types-python-dateutil==2.9.0.20240316 ; python_version >= "3.8" and python_version < "4"
-typing-extensions==4.12.2 ; python_version >= "3.8" and python_version < "4"
-urllib3==2.2.1 ; python_version >= "3.8" and python_version < "4"
-virtualenv==20.26.3 ; python_version >= "3.8" and python_version < "4"
-watchdog==4.0.0 ; python_version >= "3.8" and python_version < "4"
-wheel==0.43.0 ; python_version >= "3.8" and python_version < "3.9"
-zipp==3.18.1 ; python_version >= "3.8" and python_version < "3.10"
+arrow==1.3.0 ; python_full_version >= "3.9.0" and python_version < "4"
+babel==2.14.0 ; python_full_version >= "3.9.0" and python_version < "4"
+binaryornot==0.4.4 ; python_full_version >= "3.9.0" and python_version < "4"
+black==24.10.0 ; python_version >= "3.9" and python_version < "4"
+build==1.2.2.post1 ; python_full_version >= "3.9.0" and python_version < "4.0"
+cachecontrol[filecache]==0.14.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+cachetools==5.5.0 ; python_full_version >= "3.9.0" and python_version < "4"
+certifi==2024.2.2 ; python_full_version >= "3.9.0" and python_version < "4"
+cffi==1.17.1 ; python_full_version >= "3.9.0" and python_version < "4.0" and (sys_platform == "darwin" or sys_platform == "linux") and (sys_platform == "darwin" or platform_python_implementation != "PyPy")
+chardet==5.2.0 ; python_full_version >= "3.9.0" and python_version < "4"
+charset-normalizer==3.3.2 ; python_full_version >= "3.9.0" and python_version < "4"
+cleo==2.1.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+click==8.1.7 ; python_version >= "3.9" and python_version < "4"
+colorama==0.4.6 ; python_version >= "3.9" and python_version < "4"
+cookiecutter==1.7.3 ; python_full_version >= "3.9.0" and python_version < "4"
+coverage[toml]==7.4.4 ; python_full_version >= "3.9.0" and python_version < "4"
+crashtest==0.4.1 ; python_full_version >= "3.9.0" and python_version < "4.0"
+cryptography==43.0.3 ; python_full_version >= "3.9.0" and python_version < "4.0" and sys_platform == "linux"
+distlib==0.3.8 ; python_full_version >= "3.9.0" and python_version < "4"
+dulwich==0.21.7 ; python_full_version >= "3.9.0" and python_version < "4.0"
+exceptiongroup==1.2.1 ; python_full_version >= "3.9.0" and python_version < "3.11"
+fastjsonschema==2.20.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+filelock==3.16.1 ; python_full_version >= "3.9.0" and python_version < "4"
+ghp-import==2.1.0 ; python_version >= "3.9" and python_version < "4"
+griffe==1.2.0 ; python_version >= "3.9" and python_version < "4"
+idna==3.7 ; python_full_version >= "3.9.0" and python_version < "4"
+importlib-metadata==7.1.0 ; python_version >= "3.9" and python_version < "3.12"
+iniconfig==2.0.0 ; python_full_version >= "3.9.0" and python_version < "4"
+installer==0.7.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+jaraco-classes==3.4.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+jeepney==0.8.0 ; python_full_version >= "3.9.0" and python_version < "4.0" and sys_platform == "linux"
+jinja2-time==0.2.0 ; python_full_version >= "3.9.0" and python_version < "4"
+jinja2==3.1.3 ; python_version >= "3.9" and python_version < "4"
+keyring==24.3.1 ; python_full_version >= "3.9.0" and python_version < "4.0"
+markdown==3.6 ; python_version >= "3.9" and python_version < "4"
+markupsafe==2.1.5 ; python_version >= "3.9" and python_version < "4"
+mergedeep==1.3.4 ; python_version >= "3.9" and python_version < "4"
+mkdocs-autorefs==1.2.0 ; python_version >= "3.9" and python_version < "4"
+mkdocs-get-deps==0.2.0 ; python_version >= "3.9" and python_version < "4"
+mkdocs-material-extensions==1.3.1 ; python_full_version >= "3.9.0" and python_version < "4"
+mkdocs-material==9.5.42 ; python_full_version >= "3.9.0" and python_version < "4"
+mkdocs==1.6.1 ; python_version >= "3.9" and python_version < "4"
+mkdocstrings-python==1.12.2 ; python_version >= "3.9" and python_version < "4"
+mkdocstrings==0.26.2 ; python_version >= "3.9" and python_version < "4"
+more-itertools==10.5.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+msgpack==1.1.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+mypy-extensions==1.0.0 ; python_version >= "3.9" and python_version < "4"
+nodeenv==1.8.0 ; python_full_version >= "3.9.0" and python_version < "4"
+packaging==24.1 ; python_version >= "3.9" and python_version < "4"
+paginate==0.5.6 ; python_full_version >= "3.9.0" and python_version < "4"
+pathspec==0.12.1 ; python_version >= "3.9" and python_version < "4"
+pexpect==4.9.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+pkginfo==1.11.2 ; python_full_version >= "3.9.0" and python_version < "4.0"
+platformdirs==4.3.6 ; python_version >= "3.9" and python_version < "4"
+pluggy==1.5.0 ; python_full_version >= "3.9.0" and python_version < "4"
+poetry-core==1.9.1 ; python_full_version >= "3.9.0" and python_version < "4.0"
+poetry-plugin-export==1.8.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+poetry==1.8.4 ; python_full_version >= "3.9.0" and python_version < "4.0"
+poyo==0.5.0 ; python_full_version >= "3.9.0" and python_version < "4"
+ptyprocess==0.7.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+pycparser==2.22 ; python_full_version >= "3.9.0" and python_version < "4.0" and (sys_platform == "darwin" or sys_platform == "linux") and (sys_platform == "darwin" or platform_python_implementation != "PyPy")
+pyfakefs==5.7.1 ; python_full_version >= "3.9.0" and python_version < "4"
+pygments==2.17.2 ; python_full_version >= "3.9.0" and python_version < "4"
+pymdown-extensions==10.8 ; python_version >= "3.9" and python_version < "4"
+pyproject-api==1.8.0 ; python_full_version >= "3.9.0" and python_version < "4"
+pyproject-hooks==1.2.0 ; python_full_version >= "3.9.0" and python_version < "4.0"
+pyright==1.1.386 ; python_full_version >= "3.9.0" and python_version < "4"
+pytest-cov==5.0.0 ; python_full_version >= "3.9.0" and python_version < "4"
+pytest-dotenv==0.5.2 ; python_full_version >= "3.9.0" and python_version < "4"
+pytest-mock==3.14.0 ; python_full_version >= "3.9.0" and python_version < "4"
+pytest==8.3.3 ; python_full_version >= "3.9.0" and python_version < "4"
+python-dateutil==2.9.0.post0 ; python_version >= "3.9" and python_version < "4"
+python-dotenv==1.0.1 ; python_full_version >= "3.9.0" and python_version < "4"
+python-gitlab==4.4.0 ; python_full_version >= "3.9.0" and python_version < "4"
+python-slugify==8.0.4 ; python_full_version >= "3.9.0" and python_version < "4"
+pywin32-ctypes==0.2.3 ; python_full_version >= "3.9.0" and python_version < "4.0" and sys_platform == "win32"
+pyyaml-env-tag==0.1 ; python_version >= "3.9" and python_version < "4"
+pyyaml==5.3.1 ; python_version >= "3.9" and python_version < "4"
+rapidfuzz==3.10.1 ; python_version >= "3.9" and python_version < "4.0"
+regex==2024.4.16 ; python_full_version >= "3.9.0" and python_version < "4"
+requests-file==2.0.0 ; python_full_version >= "3.9.0" and python_version < "4"
+requests-toolbelt==1.0.0 ; python_full_version >= "3.9.0" and python_version < "4"
+requests==2.31.0 ; python_full_version >= "3.9.0" and python_version < "4"
+responses==0.25.0 ; python_full_version >= "3.9.0" and python_version < "4"
+ruff==0.7.1 ; python_full_version >= "3.9.0" and python_version < "4"
+secretstorage==3.3.3 ; python_full_version >= "3.9.0" and python_version < "4.0" and sys_platform == "linux"
+setuptools==69.5.1 ; python_full_version >= "3.9.0" and python_version < "4"
+shellingham==1.5.4 ; python_full_version >= "3.9.0" and python_version < "4.0"
+six==1.16.0 ; python_version >= "3.9" and python_version < "4"
+text-unidecode==1.3 ; python_full_version >= "3.9.0" and python_version < "4"
+tldextract==5.1.2 ; python_full_version >= "3.9.0" and python_version < "4"
+tomli==2.0.1 ; python_version >= "3.9" and python_full_version <= "3.11.0a6"
+tomlkit==0.13.2 ; python_full_version >= "3.9.0" and python_version < "4.0"
+tox==4.23.2 ; python_full_version >= "3.9.0" and python_version < "4"
+trove-classifiers==2024.10.21.16 ; python_full_version >= "3.9.0" and python_version < "4.0"
+types-python-dateutil==2.9.0.20240316 ; python_full_version >= "3.9.0" and python_version < "4"
+typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "4"
+urllib3==2.2.1 ; python_full_version >= "3.9.0" and python_version < "4"
+virtualenv==20.27.1 ; python_full_version >= "3.9.0" and python_version < "4"
+watchdog==4.0.0 ; python_version >= "3.9" and python_version < "4"
+xattr==1.1.0 ; python_full_version >= "3.9.0" and python_version < "4.0" and sys_platform == "darwin"
+zipp==3.18.1 ; python_version >= "3.9" and python_version < "3.12"
diff --git a/environment.yml b/environment.yml
@@ -2,8 +2,8 @@ name: footing
 channels:
   - conda-forge
 dependencies:
-  - python==3.12.0
-  - poetry==1.6.1
-  - pip==23.2.1
+  - python==3.13.0
+  - poetry==1.8.4
+  - pip==24.2
 variables:
   EXEC_WRAPPER: ""
diff --git a/footing.yaml b/footing.yaml
@@ -1,7 +1,7 @@
 _extensions:
 - jinja2_time.TimeExtension
 _template: [email protected]:Opus10/python-library-template.git
-_version: f4840f3f2382a912a6730a6520061e4fcc274ca1
+_version: 072543e27d8b506a6628f7793798609c62d6a8ae
 check_types_in_ci: 'False'
 is_django: 'False'
 module_name: footing

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -46,12 +46,15 @@ markdown_extensions:
         - name: mermaid
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
+  - toc:
+      permalink: true
 
 theme:
   name: material
   logo: static/logo.png
   favicon: static/logo.png
   features:
+    - content.code.copy
     - navigation.footer
     - navigation.path
     - navigation.sections