Merge pull request #327 from JamesParrott/pyshp-3.0.0-alpha

JamesParrott · web-flow · commit 31727ada6db3 · 2025-07-23T15:21:59.000+01:00
Adjust CI to test built wheels (and to publish exactly these tested wheels)
diff --git a/.github/actions/build_wheel_and_sdist/action.yml b/.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
diff --git a/.github/actions/test/action.yml b/.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,52 @@ 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: Serve shapefiles and zip file artefacts on localhost using Caddy
-      if: ${{ inputs.replace_remote_urls_with_localhost == 'yes' && inputs.python-version == '2.7'}}
-      shell: bash
-      working-directory: .
-      run: |
-        ./caddy file-server --root ./PyShp_test_shapefile --listen :8000 &
-        echo "HTTP_SERVER_PID=$!" >> $GITHUB_ENV
-        sleep 2  # give server time to start
-
     - 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 }}
 
-    - name: Install test dependencies.
+
+    - name: Download wheel and sdist (built in previous jobs)
+      uses: actions/download-artifact@v4
+      with:
+        name: PyShp_wheel_and_sdist
+        path: dist
+
+    - name: Install PyShp from the wheel (built in prev step)
       shell: bash
-      working-directory: ${{ inputs.pyshp_repo_directory }}
+      working-directory: dist/
       run: |
-        python -m pip install --upgrade pip
-        pip install -e .[test]
+        WHEEL_NAME=$(ls pyshp-*py3-none-any.whl)
+        python -m pip install $WHEEL_NAME[test]
 
-    - name: Pytest
+    - name: Show Python and Pytest versions for logs.
+      shell: bash
+      run: |
+        python --version
+        python -m pytest --version
+
+    - name: Run Pytest
       shell: bash
       working-directory: ${{ inputs.pyshp_repo_directory }}
       env:
         REPLACE_REMOTE_URLS_WITH_LOCALHOST: ${{ inputs.replace_remote_urls_with_localhost }}
       run: |
+        echo "Ensure the tests import the installed wheel"
+        mv shapefile.py __tmp.py
         pytest -rA --tb=short ${{ inputs.extra_args }}
+        mv __tmp.py shapefile.py
 
-    - name: Show versions for logs.
-      shell: bash
-      run: |
-        python --version
-        python -m pytest --version
 
 
     # - name: Test http server
diff --git a/.github/workflows/deploy.yml b/.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/
diff --git a/.github/workflows/run_checks_build_and_test.yml b/.github/workflows/run_checks_build_and_test.yml
@@ -30,7 +30,16 @@ jobs:
       run: |
         pylint --disable=R,C test_shapefile.py
 
+  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
+
   test_on_supported_Pythons:
+    needs: build_wheel_and_sdist
     strategy:
       fail-fast: false
       matrix:
@@ -63,12 +72,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 }}
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,29 @@
+[metadata]
+name = pyshp
+version = attr: shapefile.__version__
+description = Pure Python read/write support for ESRI Shapefile format
+long_description = file: README.md
+long_description_content_type = text/markdown
+author = Joel Lawhead
+author_email = jlawhead@geospatialpython.com
+maintainer = Karim Bahgat
+maintainer_email = karim.bahgat.norway@gmail.com
+url = https://github.com/GeospatialPython/pyshp
+download_url = https://pypi.org/project/pyshp/
+license = MIT
+license_files = LICENSE.TXT
+keywords = gis, geospatial, geographic, shapefile, shapefiles
+classifiers =
+    Development Status :: 5 - Production/Stable
+    Programming Language :: Python
+    Programming Language :: Python :: 3.9
+    Topic :: Scientific/Engineering :: GIS
+    Topic :: Software Development :: Libraries
+    Topic :: Software Development :: Libraries :: Python Modules
+
+[options]
+py_modules = shapefile
+python_requires = >=3.9
+
+[bdist_wheel]
+universal=1
diff --git a/shapefile.py b/shapefile.py
@@ -8,7 +8,7 @@
 
 from __future__ import annotations
 
-__version__ = "2.4.0"
+__version__ = "3.0.0-alpha"
 
 import array
 import doctest
