Merge pull request #171 from openzim/8_2_1

Using libzim 8.2.1

Author: rgaudin

.github/workflows/release.yaml

@@ -6,7 +6,7 @@ on:
       - published
 
 env:
-  LIBZIM_DL_VERSION: "8.2.0"
+  LIBZIM_DL_VERSION: "8.2.1-1"
   MACOSX_DEPLOYMENT_TARGET: "11.0"
   CIBW_ENVIRONMENT_PASS_LINUX: "LIBZIM_DL_VERSION"
   # APPLE_SIGNING_KEYCHAIN_PATH set in prepare keychain step
@@ -68,7 +68,7 @@ jobs:
           security unlock-keychain -p mysecretpassword ${APPLE_SIGNING_KEYCHAIN_PATH}
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.12.1
+        uses: pypa/cibuildwheel@v2.14
 
       - name: Cleanup Apple Keychain
         if: matrix.os == 'macos-12'

.github/workflows/test.yml

@@ -2,16 +2,16 @@ name: test
 on: [push]
 
 env:
-  LIBZIM_DL_VERSION: "2023-07-13"
+  LIBZIM_DL_VERSION: "8.2.1-1"
 
 jobs:
   lint:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3.1.0
+      - uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v4.2.0
+        uses: actions/setup-python@v4
         with:
           python-version: "3.11"
           architecture: x64
@@ -27,13 +27,13 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-22.04, macos-12]
-        python: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
-      - uses: actions/checkout@v3.1.0
+      - uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v4.2.0
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
           architecture: x64

.github/workflows/wheels.yml

@@ -7,9 +7,10 @@ on:
       - main
 
 env:
-  LIBZIM_DL_VERSION: "2023-07-13"
+  LIBZIM_DL_VERSION: "8.2.1-1"
   MACOSX_DEPLOYMENT_TARGET: "11.0"
   CIBW_ENVIRONMENT_PASS_LINUX: "LIBZIM_DL_VERSION"
+  CIBW_BUILD_VERBOSITY: "3"
 
 
 jobs:
@@ -30,7 +31,7 @@ jobs:
           platforms: all
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.12.1
+        uses: pypa/cibuildwheel@v2.14
 
       - uses: actions/upload-artifact@v3
         with:

CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Added `clean` command to setup.py to remove downloaded libzim
+
+### Changed
+
+- Build with (and target) libzim 8.2.1
+
+## Removed
+
+- Support for Python 3.7 (EOL)
+
 ## [3.1.0] - 2023-05-01
 
 ### Changed

pyproject.toml

@@ -1,9 +1,9 @@
 [build-system]
-requires = [ "setuptools >= 35.0.2", "wheel >= 0.29.0", "cython >= 0.29.34,<3.0" ]
+requires = [ "setuptools == 68.0.0", "wheel == 0.41.0", "cython == 0.29.36" ]
 build-backend = "setuptools.build_meta"
 
 [tool.black]
-target-version = ['py37', 'py38', 'py39', 'py310', 'py311']
+target-version = ['py38', 'py39', 'py310', 'py311']
 
 
 [tool.pytest.ini_options]
@@ -35,4 +35,4 @@ archs = ["x86_64", "arm64"]
 # skipping tests on cp <=3.9 as the wheels we produce are on unexpected combinations
 # because those python versions were released before our building host version
 # > requires changing wheel names
-test-skip = "*_arm64 cp39* cp38* cp37*"
+test-skip = "*_arm64 cp39* cp38*"

setup.cfg

@@ -24,7 +24,6 @@ classifiers =
     Intended Audience :: Developers
     Programming Language :: Cython
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
@@ -40,9 +39,9 @@ zim_safe = False
 packages =
     libzim
 python_requires =
-    >=3.7,<3.12
+    >=3.8,<3.12
 setup_requires =
-    cython >= 0.29.34,<0.30
+    cython == 0.29.36
 test_requires =
     pytest
 

setup.py

@@ -28,7 +28,7 @@
 
 
 class Config:
-    libzim_dl_version: str = os.getenv("LIBZIM_DL_VERSION", "8.2.0")
+    libzim_dl_version: str = os.getenv("LIBZIM_DL_VERSION", "8.2.1-1")
     use_system_libzim: bool = bool(os.getenv("USE_SYSTEM_LIBZIM", False))
     download_libzim: bool = not bool(os.getenv("DONT_DOWNLOAD_LIBZIM", False))
 
@@ -256,6 +256,18 @@ def _install_from(self, folder: pathlib.Path):
                     file=sys.stderr,
                 )
 
+    def cleanup(self):
+        """removes created files to prevent re-run issues"""
+        # we downloaded libzim, so we must remove it
+        if self.download_libzim:
+            print("removing downloaded libraries")
+            for fpath in self.dylib_file.parent.glob("*.[dylib|so]*"):
+                print(">", fpath)
+                fpath.unlink(missing_ok=True)
+            if self.header_file.parent.exists():
+                print("removing downloaded headers")
+                shutil.rmtree(self.header_file.parent, ignore_errors=True)
+
     @property
     def header_file(self) -> pathlib.Path:
         return self.base_dir / "include" / "zim" / "zim.h"
@@ -466,13 +478,30 @@ def run(self):
         config.download_to_dest()
 
 
+class LibzimClean(Command):
+    user_options = []
+
+    def initialize_options(self):
+        ...
+
+    def finalize_options(self):
+        ...
+
+    def run(self):
+        config.cleanup()
+
+
 if len(sys.argv) == 2 and sys.argv[1] in config.buildless_commands:
     ext_modules = None
 else:
     config.check_platform()
     ext_modules = get_cython_extension()
 
 setup(
-    cmdclass={"build_ext": LibzimBuildExt, "download_libzim": DownloadLibzim},
+    cmdclass={
+        "build_ext": LibzimBuildExt,
+        "download_libzim": DownloadLibzim,
+        "clean": LibzimClean,
+    },
     ext_modules=ext_modules,
 )