Merge pull request #146 from openzim/packaging

Updated package metadata and misc

Author: rgaudin

.github/workflows/release.yml

@@ -19,9 +19,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-10.15]
-        # TODO: expand this to cross-platform builds (see V2 approach below)
-        # os: [ubuntu-latest, windows-latest, macos-10.15]
+        os: [ubuntu-20.04, macos-10.15]
         python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:
@@ -62,7 +60,7 @@ jobs:
             -p "${{ secrets.APPLE_SIGNING_ALTOOL_PASSWORD }}"
 
       - name: set linux environ
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-20.04'
         run: |
           echo LIBZIM_EXT=so >> $GITHUB_ENV
           echo LIBZIM_RELEASE=libzim_linux-x86_64-$LIBZIM_VERSION >> $GITHUB_ENV
@@ -85,7 +83,7 @@ jobs:
           mv $LIBZIM_RELEASE libzim_dist
 
       - name: Link Linux libzim dylib & headers into workspace lib and include folders
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-20.04'
         run: |
           cp -dp $GITHUB_WORKSPACE/libzim_dist/lib/x86_64-linux-gnu/* lib/
           ln -s libzim.so.${LIBZIM_VERSION:0:1} lib/libzim.so
@@ -100,9 +98,9 @@ jobs:
 
       - name: Build cython and sdist
         run: |
-          pip install --upgrade "cython>=0.29.28,<3.0" setuptools pip wheel
+          pip install --upgrade "cython>=0.29.30,<3.0" setuptools pip wheel
           python3 setup.py build_ext --rpath $RPATH
-          if [[  "${{ matrix.python-version }}" == "3.6" ]]
+          if [[  "${{ matrix.python-version }}" == "3.8" ]]
           then
             python3 setup.py sdist
           fi
@@ -136,7 +134,7 @@ jobs:
           spctl -a -v -t install ${wrapper} || true
 
       - name: add Linux libzim binary to source for wheel
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-20.04'
         run: cp -pv lib/libzim.so.${LIBZIM_VERSION:0:1} $(find build/lib* -type d)/
 
       - name: build wheel
@@ -152,7 +150,7 @@ jobs:
         run: |
           pip install --upgrade twine
           twine check dist/*
-          if [  "${{ matrix.os }}" == "ubuntu-latest" -a "${{ matrix.python-version }}" = "3.6" ]
+          if [  "${{ matrix.os }}" == "ubuntu-20.04" -a "${{ matrix.python-version }}" = "3.8" ]
           then
             twine upload dist/*.tar.gz
           fi

.github/workflows/test.yml

@@ -9,7 +9,7 @@ env:
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
 
@@ -29,10 +29,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-10.15]
-        # TODO: expand this once macos and windows libzim releases become available
-        # os: [ubuntu-latest, windows-latest, macos-10.15]
-        # alternatively we can compile libzim in docker and use the container as an action
+        os: [ubuntu-20.04, macos-10.15]
         python: ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:
@@ -52,7 +49,7 @@ jobs:
           echo LIBZIM_LIBRARY_PATH=lib/libzim.7.dylib >> $GITHUB_ENV
 
       - name: set linux environ
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-20.04'
         run: |
           echo LIBZIM_EXT=so >> $GITHUB_ENV
           echo LIBZIM_RELEASE=libzim_linux-x86_64-$LIBZIM_VERSION >> $GITHUB_ENV
@@ -80,7 +77,7 @@ jobs:
           export LD_LIBRARY_PATH="$PWD/lib:$LD_LIBRARY_PATH"
 
       - name: update Linux shared objects cache
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-20.04'
         run: |
           sudo ldconfig $PWD/lib
 
@@ -91,7 +88,7 @@ jobs:
 
       - name: Build cython, sdist, and bdist_wheel
         run: |
-          pip install --upgrade pip install "cython>=0.29.28,<3.0" setuptools pip wheel
+          pip install --upgrade pip install "cython>=0.29.30,<3.0" setuptools pip wheel
           python3 setup.py build_ext --inplace
           python3 setup.py sdist bdist_wheel
 

CHANGELOG.md

@@ -7,7 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-* n/a
+### Changed
+
+* Building with Cython 0.29.30
+* Specifying max python version to 3.10.x in metadata
 
 ## [1.1.0] - 2022-05-23
 

pyproject.toml

@@ -1,9 +1,9 @@
 [build-system]
-requires = [ "setuptools >= 35.0.2", "wheel >= 0.29.0", "twine", "cython >= 0.29.28,<3.0" ]
+requires = [ "setuptools >= 35.0.2", "wheel >= 0.29.0", "twine", "cython >= 0.29.30,<3.0" ]
 build-backend = "setuptools.build_meta"
 
 [tool.black]
-target-version = ['py36', 'py37', 'py38']
+target-version = ['py36', 'py37', 'py38', 'py39', 'py310']
 
 
 [tool.pytest.ini_options]

requirements-dev.txt

@@ -5,4 +5,4 @@ invoke>=1.5,<2.0
 coverage>=5.0,<7.0
 pytest>=6.2,<7.0
 pytest-cov>=2.10,<4.0
-Cython>=0.29.28
+Cython>=0.29.30

setup.cfg

@@ -7,13 +7,13 @@ project_urls =
 description = A python-facing API for creating and interacting with ZIM files
 author = Monadical Inc.
 author_email = [email protected]
-maintainer = Openzim team
-maintainer_email = contact@openzim.org
+maintainer = openZIM
+maintainer_email = contact+openzim@kiwix.org
 long_description = file: README.md
 long_description_content_type = text/markdown
 license = GPL-3.0-or-later
 classifiers =
-    Development Status :: 3 - Alpha
+    Development Status :: 5 - Production/Stable
     Topic :: Utilities
     Topic :: Software Development :: Libraries
     Topic :: Software Development :: Libraries :: Python Modules
@@ -29,19 +29,20 @@ classifiers =
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
-    #Typing :: Typed
+    Typing :: Stubs Only
     License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-    Operating System :: OS Independent
+    Operating System :: MacOS
+    Operating System :: POSIX
 
 [options]
 include_package_data = True
 zim_safe = False
 packages =
     libzim
 python_requires =
-    >=3.6
+    >=3.6,<3.11
 setup_requires =
-    cython
+    cython >= 0.29.30,<0.30
 test_requires =
     pytest