Bump up minimum Python version to 3.10 (#313)

* Initial changes to bump up Python version to 3.10 * Update README and try build with sphinx=4.2 for python3.10 support * Unpin version from dockerfile * Update readthedocs config file * Update docs/requirements.txt Co-authored-by: Michael Diamant <[email protected]> Co-authored-by: Michael Diamant <[email protected]>
algorand · Apr 19, 2022 · 006b3a0 · 006b3a0
1 parent 5e67f64
commit 006b3a0
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 17 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -11,7 +11,7 @@ workflows:
 jobs:
   unit-test:
     docker:
-      - image: python:3.7.9
+      - image: python:3.10
     steps:
       - checkout
       - run: pip install -r requirements.txt
@@ -26,7 +26,7 @@ jobs:
   docset:
     docker:
       # NOTE: We might eventually need Docker authentication here.
-      - image: cimg/python:3.9
+      - image: cimg/python:3.10
     steps:
       - checkout
       - run:

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/.travis.yml b/.travis.yml
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM python:3.7.9
+FROM python:3.10
 
 # Copy SDK code into the container
 RUN mkdir -p $HOME/py-algorand-sdk

diff --git a/README.md b/README.md
@@ -13,6 +13,8 @@ Run `$ pip3 install py-algorand-sdk` to install the package.
 
 Alternatively, choose a [distribution file](https://pypi.org/project/py-algorand-sdk/#files), and run `$ pip3 install [file name]`.
 
+The py-algorand-sdk requires Python `3.10` to be installed. Please upgrade your Python version or consider using tools to manage multiple Python versions like [pyenv](https://github.com/pyenv/pyenv).
+
 ## SDK Development
 
 Install dependencies

diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "algosdk"
-copyright = "2020 Algorand"
+copyright = "2022 Algorand"
 author = "Algorand"
 
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,3 @@
-sphinx==4.0.1
-sphinx-rtd-theme
+sphinx==4.2.0
+sphinx-rtd-theme==1.0.0
 m2r2
diff --git a/setup.py b/setup.py
@@ -22,7 +22,7 @@
         "msgpack>=1.0.0,<2",
     ],
     packages=setuptools.find_packages(),
-    python_requires=">=3.5",
+    python_requires=">=3.10",
     package_data={"": ["data/langspec.json"]},
     include_package_data=True,
 )