Merge pull request #348 from GeospatialPython/3.0.0-alpha

3.0.0 alpha.

Author: JamesParrott

.github/actions/build_wheel_and_sdist/action.yml

@@ -0,0 +1,47 @@
+name:
+  Build a Wheel and source distribution.
+
+description:
+  Run pyproject-build on the repo
+
+
+runs:
+  using: "composite"
+  steps:
+    # The PyShp repo is required to already be checked out into .,
+    # e.g. by the calling workflow using:
+    # steps:
+    # - uses: actions/checkout@v4
+    #
+    # and then calling this Action with:
+    # - name: Run tests
+    #   uses: .github/actions/build_wheel_and_sdist
+
+    # The Python to be tested with is required to already be setup,
+    # with "python" and "pip" on the system Path
+    # (so that this custom Action can be used with both reproducible
+    #  Pythons from Python docker images, and more frequently deprecated Pythons
+    #  from - uses: actions/setup-python@v5)
+
+    - name: Install build (PyPA's pyproject-build)
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install build
+
+    - name: Show versions for logs.
+      shell: bash
+      run: |
+        python --version
+        python -m build --version
+
+    - name: Build the default distributions (wheel & sdist, in dist/).
+      shell: bash
+      working-directory: ${{ inputs.pyshp_repo_directory }}
+      run: python -m build
+
+    - name: Upload built distributions
+      uses: actions/upload-artifact@v4
+      with:
+        name: PyShp_wheel_and_sdist
+        path: dist

.github/actions/test/action.yml

@@ -17,30 +17,38 @@ inputs:
     description: Path to where the PyShp repo was checked out to (to keep separate from Shapefiles & artefacts repo).
     required: false
     default: '.'
-  python-version:
-    description: Set to "2.7" to use caddy instead of python -m SimpleHTTPServer
-    required: true
 
 
 
 runs:
   using: "composite"
   steps:
     # The PyShp repo is required to already be checked out into pyshp_repo_directory,
+    # and the wheel to be tested in ./dist within it.
     # e.g. by the calling workflow using:
     # steps:
     # - uses: actions/checkout@v4
     #   with:
     #     path: ./Pyshp
+    #
+    # - name: Build distribution artefacts (wheel and sdist)
+    #   uses: ./Pyshp/.github/actions/build_wheel_and_sdist
+    #
     # and then calling this Action with:
+    #
     # - name: Run tests
     #   uses: ./Pyshp/.github/actions/test
     #   with:
     #     extra_args: ""
     #     replace_remote_urls_with_localhost: 'yes'
     #     pyshp_repo_directory: ./Pyshp
 
-    # The Python to be tested with is required to already be setup, with "python" and "pip" on the system Path
+    # The Python to be tested with is required to already be setup,
+    # with "python" and "pip" on the system Path
+    # (so that this custom Action can be used with both reproducible
+    #  Pythons from Python docker images, and more frequently deprecated Pythons
+    #  from - uses: actions/setup-python@v5)
+
 
     - name: Checkout shapefiles and zip file artefacts repo
       if: ${{ inputs.replace_remote_urls_with_localhost == 'yes' }}
@@ -50,58 +58,47 @@ runs:
         path: ./PyShp_test_shapefile
 
     - name: Serve shapefiles and zip file artefacts on localhost
-      if: ${{ inputs.replace_remote_urls_with_localhost == 'yes'  && inputs.python-version != '2.7'}}
+      if: ${{ inputs.replace_remote_urls_with_localhost == 'yes' }}
       shell: bash
       working-directory: ./PyShp_test_shapefile
       run: |
         python -m http.server 8000 &
         echo "HTTP_SERVER_PID=$!" >> $GITHUB_ENV
         sleep 4  # give server time to start
 
-    - name: Download and unzip Caddy binary
-      if: ${{ inputs.replace_remote_urls_with_localhost == 'yes' && inputs.python-version == '2.7'}}
-      working-directory: .
-      shell: bash
-      run: |
-        curl -L https://github.com/caddyserver/caddy/releases/download/v2.10.0/caddy_2.10.0_linux_amd64.tar.gz --output caddy.tar.gz
-        tar -xzf caddy.tar.gz
+    - name: Download wheel and sdist (built in previous jobs)
+      uses: actions/download-artifact@v4
+      with:
+        name: PyShp_wheel_and_sdist
+        path: dist
 
-    - name: Serve shapefiles and zip file artefacts on localhost using Caddy
-      if: ${{ inputs.replace_remote_urls_with_localhost == 'yes' && inputs.python-version == '2.7'}}
+    - name: Install PyShp from the wheel (downloaded in prev step)
       shell: bash
-      working-directory: .
+      working-directory: dist/
       run: |
-        ./caddy file-server --root ./PyShp_test_shapefile --listen :8000 &
-        echo "HTTP_SERVER_PID=$!" >> $GITHUB_ENV
-        sleep 2  # give server time to start
+        WHEEL_NAME=$(ls pyshp-*py3-none-any.whl)
+        python -m pip install $WHEEL_NAME[test]
 
     - name: Doctests
       shell: bash
       working-directory: ${{ inputs.pyshp_repo_directory }}
       env:
         REPLACE_REMOTE_URLS_WITH_LOCALHOST: ${{ inputs.replace_remote_urls_with_localhost }}
-      run: python shapefile.py ${{ inputs.extra_args }}
+      run: python test_shapefile.py ${{ inputs.extra_args }}
 
-    - name: Install test dependencies.
+    - name: Show Python and Pytest versions for logs.
       shell: bash
-      working-directory: ${{ inputs.pyshp_repo_directory }}
       run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.test.txt
+        python --version
+        python -m pytest --version
 
-    - name: Pytest
+    - name: Run Pytest
       shell: bash
       working-directory: ${{ inputs.pyshp_repo_directory }}
       env:
         REPLACE_REMOTE_URLS_WITH_LOCALHOST: ${{ inputs.replace_remote_urls_with_localhost }}
-      run: |
-        pytest -rA --tb=short ${{ inputs.extra_args }}
+      run: pytest -rA --tb=short ${{ inputs.extra_args }}
 
-    - name: Show versions for logs.
-      shell: bash
-      run: |
-        python --version
-        python -m pytest --version
 
 
     # - name: Test http server

.github/workflows/deploy.yml

@@ -13,16 +13,13 @@ on:
     types: [published]
 
 jobs:
-  test:
-    # In general, tests should be run after building a distribution, to test that distribution.
-    # However as long as PyShp is a pure Python library, with pure Python deps (or no deps)
-    # then this would only test the packaging process, not so much the code as there are
-    # no binaries.
-    uses: ./.github/workflows/run_tests_hooks_and_tools.yml
+  format_type_check_lint_build_and_test:
+    # Builds and uploads wheel and sdist
+    uses: ./.github/workflows/run_checks_build_and_test.yml
 
   deploy:
-    # Prevent deployment of releases that fail any hooks (e.g. linting) or that fail any tests.
-    needs: test
+    # Prevent deployment of releases that fail any tests or checks (e.g. linting).
+    needs: format_type_check_lint_build_and_test
     runs-on: ubuntu-latest
 
     steps:
@@ -33,17 +30,18 @@ jobs:
         python-version: '3.x'
 
 
+    - name: Download wheel and sdist (built in previous job)
+      uses: actions/download-artifact@v4
+      with:
+        name: PyShp_wheel_and_sdist
+        path: dist
+
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
 
     - name: Publish package
       if: github.repository == 'GeospatialPython/pyshp'
       uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
       with:
         user: __token__
         password: ${{ secrets.PYPI_INTEGRATION }}
+        packages-dir: dist/

.github/workflows/run_tests_hooks_and_tools.yml renamed to .github/workflows/run_checks_build_and_test.yml

@@ -5,7 +5,6 @@ name: Run pre-commit hooks and tests
 on:
   push:
   pull_request:
-    branches: [ master, ]
   workflow_call:
   workflow_dispatch:
 
@@ -17,55 +16,16 @@ jobs:
     - uses: actions/setup-python@v5
     - uses: pre-commit/[email protected]
 
-  pylint:
+  build_wheel_and_sdist:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
-    - name: install Pylint and plugin
-      run: |
-        python -m pip install --upgrade pip
-        pip install pytest pylint pylint-per-file-ignores
-    - name: run Pylint for errors and warnings only, on test_shapefile.py
-      run: |
-        pylint --disable=R,C test_shapefile.py
-
-  test_on_EOL_Pythons:
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [
-            "2.7",
-            "3.5",
-            "3.6",
-            "3.7",
-            "3.8",
-        ]
-
-    runs-on: ubuntu-latest
-    container:
-      image: python:${{ matrix.python-version }}
-
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        path: ./Pyshp
-
-    - name: Non-network tests
-      uses: ./Pyshp/.github/actions/test
-      with:
-        pyshp_repo_directory: ./Pyshp
-        python-version: ${{ matrix.python-version }}
-
-    - name: Network tests
-      uses: ./Pyshp/.github/actions/test
-      with:
-        extra_args: '-m network'
-        replace_remote_urls_with_localhost: 'yes'
-        pyshp_repo_directory: ./Pyshp
-        python-version: ${{ matrix.python-version }}
+    - name: Build wheel from the project repo
+      uses: ./.github/actions/build_wheel_and_sdist
 
   test_on_supported_Pythons:
+    needs: build_wheel_and_sdist
     strategy:
       fail-fast: false
       matrix:
@@ -98,12 +58,11 @@ jobs:
       uses: ./Pyshp/.github/actions/test
       with:
         pyshp_repo_directory: ./Pyshp
-        python-version: ${{ matrix.python-version }}
 
     - name: Network tests
       uses: ./Pyshp/.github/actions/test
       with:
         extra_args: '-m network'
         replace_remote_urls_with_localhost: 'yes'
+        # Checkout to ./PyShp, as the test job also needs to check out the artefact repo
         pyshp_repo_directory: ./Pyshp
-        python-version: ${{ matrix.python-version }}

.github/workflows/speed_test.yml

@@ -8,7 +8,17 @@ on:
 
 jobs:
 
+
+  build_wheel_and_sdist:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - name: Build wheel from the project repo
+      uses: ./.github/actions/build_wheel_and_sdist
+
   run_speed_tests:
+    needs: build_wheel_and_sdist
     strategy:
       fail-fast: false
       matrix:
@@ -28,17 +38,23 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: Download wheel and sdist (built in previous job)
+      uses: actions/download-artifact@v4
+      with:
+        name: PyShp_wheel_and_sdist
+        path: dist
+
+    - name: Install PyShp + test deps from the wheel (downloaded in prev step)
+      shell: bash
+      working-directory: dist/
+      run: |
+        WHEEL_NAME=$(ls pyshp-*py3-none-any.whl)
+        python -m pip install $WHEEL_NAME[test]
 
     - uses: actions/checkout@v4
       with:
         path: ./Pyshp
 
-    - name: Install PyShp + test deps
-      shell: bash
-      working-directory: ./Pyshp
-      run: |
-        python -m pip install -r requirements.test.txt
-        python -m pip install -e .
 
 
     - name: Checkout shapefiles and zip file artefacts repo
@@ -50,7 +66,7 @@ jobs:
     - name: Run Speed tests.
       env:
         PYSHP_TEST_REPO: ./PyShp_test_shapefile
-      run: python Pyshp/run_benchmarks.py
+      run: python ./Pyshp/run_benchmarks.py
 
 
 

.gitignore

@@ -22,5 +22,8 @@ dist/
 .vscode
 .dmypy.json
 .python-version
-.venv
-venv
+.venv/
+venv/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/

.pre-commit-config.yaml

@@ -1,15 +1,24 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.6.4
+  rev: v0.12.7
   hooks:
+    # Run the linter
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter
     - id: ruff-format
 - repo: https://github.com/pycqa/isort
-  rev: 5.13.2
+  rev: 6.0.1
   hooks:
     - id: isort
       name: isort (python)
+      args: ["--profile", "black"]
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v2.3.0
+  rev: v5.0.0
   hooks:
     - id: check-yaml
     - id: trailing-whitespace
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.17.1
+  hooks:
+    - id: mypy