feat(python): Add python 3.11 support and cleanup (#69)

This PR removes python 3.6, as it's not maintained any more. Additionally, it adds support for python 3.10 and 3.11 and updated pre-commits and dependencies to fit the new python versions.

Author: MichaelsJP

.github/workflows/ci-production.yml

@@ -10,48 +10,37 @@ on:
       - created
 
 jobs:
-  linux-tests:
+  pytest:
     strategy:
       fail-fast: false
       matrix:
-        config:
-          - python-version: 3.6
-            tox: 36
-          - python-version: 3.7
-            tox: 37
-          - python-version: 3.8
-            tox: 38
-          - python-version: 3.9
-            tox: 39
-          - python-version: pypy-3.6
-            tox: py3
-          - python-version: pypy-3.7
-            tox: py3
-        poetry-version: [ 1.1.4 ]
-        os: [ macos-latest, windows-2019, ubuntu-20.04, ubuntu-18.04 ]
+        python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11", "pypy3.7", "pypy3.8", "pypy3.9" ]
+        poetry-version: [ "latest" ]
+        os: [ ubuntu-20.04, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
+    name: Python ${{ matrix.python-version }} / Poetry ${{ matrix.poetry-version }} / ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up testing Python ${{ matrix.config.python-version }}
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
         with:
-          python-version: ${{ matrix.config.python-version }}
-          architecture: x64
-      - name: Set up base Python 3.9
-        uses: actions/setup-python@v2
+          fetch-depth: 0
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.9
-          architecture: x64
-      - name: Python Poetry Action
-        uses: abatilo/actions-poetry@v2.1.0
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+      - name: Run Poetry action
+        uses: abatilo/actions-poetry@v2
         with:
           poetry-version: ${{ matrix.poetry-version }}
+      - name: View poetry --version
+        run: poetry --version
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install tox
-      - name: Run Tox
-        run: tox -e py${{ matrix.config.tox }}
+        run: poetry install
+      - name: Run tests
+        run: poetry run pytest
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1
         with:
@@ -65,17 +54,17 @@ jobs:
     name: Build and publish Python distributions 📦 to PyPI and TestPyPI
     runs-on: ubuntu-20.04
     needs:
-      - linux-tests
+      - pytest
     steps:
       - uses: actions/checkout@v2
       - name: Set up base Python 3.9
         uses: actions/setup-python@v2
         with:
           python-version: 3.9
       - name: Python Poetry Action
-        uses: abatilo/actions-poetry@v2.1.0
+        uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: 1.1.4
+          poetry-version: latest
       - name: Publish distribution 📦 with test.pypi.org
         if: startsWith(github.ref, 'refs/tags')
         run: |

.github/workflows/ci-tests.yml

@@ -14,67 +14,52 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.9
-      - name: Python Poetry Action
-        uses: abatilo/[email protected]
-        with:
-          poetry-version: 1.1.4
-      - name: Install lint dependencies
+      - name: Update pip
         run: |
-          pip install tox pytest pytest-cov
+          python -m pip install --upgrade pip
       - name: Install and run pre-commit
         uses: pre-commit/[email protected]
         with:
           extra_args: --all-files
-  test:
+  pytest:
     needs:
       - lint
     strategy:
       fail-fast: false
       matrix:
-        config:
-          - python-version: 3.6
-            tox: 36
-          - python-version: 3.7
-            tox: 37
-          - python-version: 3.8
-            tox: 38
-          - python-version: 3.9
-            tox: 39
-          - python-version: pypy-3.6
-            tox: py3
-          - python-version: pypy-3.7
-            tox: py3
-        poetry-version: [ 1.1.4 ]
-        os: [ macos-latest, windows-2019, ubuntu-20.04, ubuntu-18.04 ]
+        python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11", "pypy3.7", "pypy3.8", "pypy3.9" ]
+        poetry-version: [ "latest" ]
+        os: [ ubuntu-20.04, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
+    name: Python ${{ matrix.python-version }} / Poetry ${{ matrix.poetry-version }} / ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up testing Python ${{ matrix.config.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.config.python-version }}
-        architecture: x64
-    - name: Set up base Python 3.9
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.9
-        architecture: x64
-    - name: Python Poetry Action
-      uses: abatilo/[email protected]
-      with:
-        poetry-version: ${{ matrix.poetry-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox
-    - name: Run Tox
-      run: tox -e py${{ matrix.config.tox }}
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
-        flags: unittests
-        env_vars: OS,PYTHON
-        name: codecov-umbrella
-        fail_ci_if_error: true
-        verbose: true
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+      - name: Run Poetry action
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: View poetry --version
+        run: poetry --version
+      - name: Install dependencies
+        run: poetry install
+      - name: Run tests
+        run: poetry run pytest
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: unittests
+          env_vars: OS,PYTHON
+          name: codecov-umbrella
+          fail_ci_if_error: true
+          verbose: true

.gitignore

@@ -1,5 +1,6 @@
 .tox/
-.venv/
+.venv*
+.env*
 .coverage
 **/.ipynb_checkpoints/
 *.geojson

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v4.4.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -22,16 +22,27 @@ repos:
         args: [ --branch, main ]
 
   - repo: https://github.com/ambv/black
-    rev: stable
+    rev: 23.3.0
     hooks:
       - id: black
         args: # arguments to configure black
           - --line-length=80
-        language_version: python3.9
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: "3.8.4"
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
     hooks:
       - id: flake8
+        additional_dependencies:
+          [
+            "flake8-bugbear",
+            "flake8-coding",
+            "flake8-comprehensions",
+            "flake8-debugger",
+            "flake8-deprecated",
+            "flake8-pep3101",
+            "flake8-polyfill",
+            "flake8-print",
+            "flake8-docstrings",
+          ]
         exclude: |
           (?x)(
               ^test/* |
@@ -40,16 +51,3 @@ repos:
         args:
           - "--max-line-length=120"
           - "--ignore=P101,D202,D401"
-        additional_dependencies:
-          [
-              "flake8-bugbear==19.8.0",
-              "flake8-coding==1.3.2",
-              "flake8-comprehensions==3.0.1",
-              "flake8-debugger==3.2.1",
-              "flake8-deprecated==1.3",
-              "flake8-pep3101==1.2.1",
-              "flake8-polyfill==1.0.2",
-              "flake8-print==3.1.4",
-              "flake8-string-format==0.2.3",
-              "flake8-docstrings==1.5.0",
-          ]

AUTHORS

@@ -16,4 +16,5 @@ Google Inc.
 
 # Modified to fit ORS needs by
 
+Julian Psotta <[email protected]>
 Nils Nolde <[email protected]>

CONTRIBUTORS

@@ -6,6 +6,7 @@
 
 # Please keep the list sorted by first name.
 
+Julian Psotta <[email protected]>
 Nils Nolde <[email protected]>
 
 # The following people contributed to the original Python Client for Google Maps Services:

docs/source/conf.py

@@ -46,18 +46,18 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"openrouteservice-py"
-copyright = u"2018, Nils Nolde"
-author = u"Nils Nolde"
+project = "openrouteservice-py"
+copyright = "2023, HeiGIT gGmbH"
+author = "HeiGIT gGmbH"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u"0.4"
+version = "0.4"
 # The full version, including alpha/beta/rc tags.
-release = u"0.4"
+release = "0.4"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -139,8 +139,8 @@
     (
         master_doc,
         "openrouteservice-py.tex",
-        u"openrouteservice-py Documentation",
-        u"Nils Nolde",
+        "openrouteservice-py Documentation",
+        "HeiGIT gGmbH",
         "manual",
     ),
 ]
@@ -153,7 +153,7 @@
     (
         master_doc,
         "openrouteservice-py",
-        u"openrouteservice-py Documentation",
+        "openrouteservice-py Documentation",
         [author],
         1,
     )
@@ -168,7 +168,7 @@
     (
         master_doc,
         "openrouteservice-py",
-        u"openrouteservice-py Documentation",
+        "openrouteservice-py Documentation",
         author,
         "openrouteservice-py",
         "One line description of project.",

openrouteservice/client.py

@@ -385,7 +385,6 @@ def _normalize_for_urlencode(value):  # pragma: no cover
 
         return _normalize_for_urlencode(str(value))
 
-
 except NameError:
 
     def _normalize_for_urlencode(value):

openrouteservice/convert.py

@@ -196,6 +196,6 @@ def decode_polyline(polyline, is3d=False):
         else:
             points.append([round(lng * 1e-5, 6), round(lat * 1e-5, 6)])
 
-    geojson = {u"type": u"LineString", u"coordinates": points}
+    geojson = {"type": "LineString", "coordinates": points}
 
     return geojson

openrouteservice/directions.py

@@ -200,15 +200,15 @@ def directions(
     # call optimization endpoint and get new order of waypoints
     if optimize_waypoints is not None and not dry_run:
         if len(coordinates) <= 3:
-            warnings.warn(
+            warnings.warn(  # noqa: B028
                 "Less than 4 coordinates, nothing to optimize!", UserWarning
             )
         elif options:
-            warnings.warn(
+            warnings.warn(  # noqa: B028
                 "Options are not compatible with optimization.", UserWarning
             )
         elif preference == "shortest":
-            warnings.warn(
+            warnings.warn(  # noqa: B028
                 "Shortest is not compatible with optimization.", UserWarning
             )
         else: