Add documentation for ensuring python versions are the same at variou…

…s locations and information about python version in README.md
GaloisInc · May 15, 2024 · dc5bc2b · dc5bc2b
1 parent 23ad855
commit dc5bc2b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,6 +19,7 @@ jobs:
     steps:
     - uses: actions/setup-python@v2
       with:
+        # Ensure TOML file and mypy.ini file are updated to support version here.
         python-version: '3.12'
     - uses: abatilo/[email protected]
       with:

diff --git a/python/README.md b/python/README.md
@@ -1,3 +1,7 @@
 # Argo Client
 
 A python library for client connections to [JSON RPC](https://www.jsonrpc.org/specification) servers, specifically designed with the Haskell [Argo](https://github.com/galoisinc/argo) sister library in mind.
+
+## Python Version Support
+
+Currently argo is tested against Python 3.12.
diff --git a/python/mypy.ini b/python/mypy.ini
@@ -1,5 +1,6 @@
 [mypy]
 no_implicit_optional = True
+# Ensure CI file matches python version here.
 python_version = 3.12
 warn_return_any = True
 warn_unused_configs = True