Update to a scikit-build build. (#33)

Using scikit-build-core for the full build.

It still needs libgd and its dependencies -- works fine with conda-forge, but still working on other sources of libs.


* removed  old setup.py

Co-authored-by: Henry Schreiner <henryschreineriii@gmail.com>

Author: ChrisBarker-NOAA

.github/workflows/conda_test.yml

@@ -1,6 +1,10 @@
 name: Run tests with miniforge
 on: [push]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     name: Miniconda ${{ matrix.os }} Py${{ matrix.pyver }}
@@ -15,10 +19,8 @@ jobs:
       - uses: conda-incubator/setup-miniconda@v3
         with:
           auto-update-conda: true
-          activate-environment: test
           miniforge-version: latest
           python-version: ${{ matrix.pyver }}
-          auto-activate-base: false
           conda-remove-defaults: true
 
       - name: Setup environment
@@ -49,10 +51,8 @@ jobs:
       - uses: conda-incubator/setup-miniconda@v3
         with:
           auto-update-conda: true
-          activate-environment: test
           miniforge-version: latest
           python-version: "3.10"
-          auto-activate-base: false
           conda-remove-defaults: true
       - name: Lint
         shell: bash -l {0}

.github/workflows/static_docs.yml

@@ -1,12 +1,13 @@
 # Simple workflow for deploying static content to GitHub Pages
 name: Deploy static content to Pages
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
-  # Runs on pushes targeting the default branch
   push:
     branches: ["main"]
-
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -15,12 +16,6 @@ permissions:
   pages: write
   id-token: write
 
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
 jobs:
   # Single deploy job since we're just deploying
   deploy:
@@ -45,5 +40,6 @@ jobs:
           # Upload entire repository
           path: 'docs/build/html'
       - name: Deploy to GitHub Pages
+        # if: github.ref == 'refs/heads/main'
         id: deployment
         uses: actions/deploy-pages@v4

.gitignore

@@ -1,9 +1,14 @@
 #specific to this repo:
 
+# generated by cython
 py_gd/py_gd.c
-# docs/examples/*.png
-# docs/examples/*.gif
 
+# generated by cibuildwheel for the libs
+install/
+libgd/
+build-libgd/
+libpng/
+build-libpng/
 
 # mac files
 .DS_Store
@@ -37,3 +42,4 @@ var/
 
 #Test Files
 test_images_output/
+wheelhouse/

CMakeLists.txt

@@ -0,0 +1,41 @@
+cmake_minimum_required(VERSION 3.24...4.0)
+project(${SKBUILD_PROJECT_NAME} LANGUAGES C)
+
+option(BUILD_DEPS OFF)
+
+find_package(
+  Python
+  COMPONENTS Interpreter Development.Module NumPy
+  REQUIRED)
+
+include(UseCython)
+include(GNUInstallDirs)
+
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
+
+if(ENV{VCPKG_ROOT})
+  message(STATUS "VCPKG_ROOT: $ENV{VCPKG_ROOT}")
+  set(CMAKE_TOOLCHAIN_FILE "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake")
+endif()
+
+# We do not use FetchContent because the CMakeLists of GD is terrible
+if(BUILD_DEPS)
+    include(BuildGD)
+else()
+    find_package(GD MODULE REQUIRED)
+endif()
+
+cython_transpile(py_gd/py_gd.pyx LANGUAGE C OUTPUT_VARIABLE py_gd_c)
+python_add_library(py_gd MODULE "${py_gd_c}" WITH_SOABI)
+target_link_libraries(py_gd PUBLIC GD::GD Python::NumPy)
+install(TARGETS py_gd DESTINATION py_gd)
+
+get_filename_component(GD_LIBRARY_DIR "${GD_LIBRARIES}" DIRECTORY)
+set_target_properties(py_gd PROPERTIES INSTALL_RPATH "${GD_LIBRARY_DIR}")
+
+cython_transpile(py_gd/spline.pyx LANGUAGE C OUTPUT_VARIABLE spline_c)
+python_add_library(spline MODULE "${spline_c}" WITH_SOABI)
+target_link_libraries(spline PUBLIC Python::NumPy)
+install(TARGETS spline DESTINATION py_gd)
+
+

cmake/FindGD.cmake

@@ -0,0 +1,46 @@
+find_package(PkgConfig)
+if(PKG_CONFIG_FOUND)
+  pkg_check_modules(PC_GD QUIET GD)
+endif()
+
+find_path(GD_INCLUDE_DIR
+  NAMES gd.h
+  HINTS "${PC_GD_INCLUDE_DIRS}"
+)
+
+find_library(GD_LIBRARY
+  NAMES gd
+  HINTS "${PC_GD_INCLUDE_DIRS}"
+)
+
+cmake_path(ABSOLUTE_PATH GD_LIBRARY)
+cmake_path(ABSOLUTE_PATH GD_INCLUDE_DIR)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(GD
+  REQUIRED_VARS
+    GD_LIBRARY
+    GD_INCLUDE_DIR
+  VERSION_VAR GD_VERSION
+)
+
+if(GD_FOUND)
+  set(GD_LIBRARIES "${GD_LIBRARY}")
+  set(GD_INCLUDE_DIRS "${GD_INCLUDE_DIR}")
+  set(Foo_DEFINITIONS ${PC_GD_CFLAGS_OTHER})
+endif()
+
+if(GD_FOUND AND NOT TARGET GD::GD)
+  add_library(GD::GD UNKNOWN IMPORTED)
+  set_target_properties(GD::GD PROPERTIES
+    IMPORTED_LOCATION "${GD_LIBRARY}"
+    INTERFACE_COMPILE_OPTIONS "${PC_GD_CFLAGS_OTHER}"
+    INTERFACE_INCLUDE_DIRECTORIES "${GD_INCLUDE_DIR}"
+  )
+endif()
+
+mark_as_advanced(
+  GD_INCLUDE_DIR
+  GD_LIBRARY
+)
+

conda_requirements_dev.txt

@@ -4,4 +4,8 @@ cython>=3
 pytest
 sphinx
 ipython  # nice to have, and used to help render the docs
-
+cmake
+ninja
+scikit-build-core
+cython-cmake
+python-build

py_gd/__init__.py

@@ -13,7 +13,7 @@
 import sys
 import os
 
-__version__ = "2.3.2"
+__version__ = "2.3.3"
 
 if sys.platform.startswith('win'):
     # This only works for Anaconda / miniconda
@@ -33,14 +33,15 @@
     #                        "This kludge is only written to support Anaconda installs")
 
     # alternative ugly kludge: add lib dir to PATH:
-    if not (os.path.isfile(os.path.join(libpath, 'libpng16.dll')) and
+    if (os.path.isfile(os.path.join(libpath, 'libpng16.dll')) and
             os.path.isfile(os.path.join(libpath, 'zlib.dll')) and
             os.path.isfile(os.path.join(libpath, 'libgd.dll'))):
-        raise RuntimeError("Can't find dlls for libgd, libpng, and libz.\n"
-                           "This kludge is only written to support Anaconda installs\n",
-                           "you may need to add some logic for other library locations",
-                           )
-    os.environ['PATH'] = libpath + os.pathsep + os.environ['PATH']
+        os.environ['PATH'] = libpath + os.pathsep + os.environ['PATH']
+
+        # raise RuntimeError("Can't find dlls for libgd, libpng, and libz.\n"
+        #                    "This kludge is only written to support Anaconda installs\n",
+        #                    "you may need to add some logic for other library locations",
+        #                    )
 try:
     from .py_gd import *  # noqa: F401
 

pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["scikit-build-core", "cython", "numpy", "cython-cmake"]
+build-backend = "scikit_build_core.build"
+
+[project]
+name = "py-gd"
+dynamic = ["version"]
+description = "python wrappers around libgd graphics lib"
+readme = "README.md"
+license = "CC0-1.0"
+license-files = ["LICENSE.txt"]
+requires-python = ">=3.10"
+authors = [
+    { name = "Christopher H. Barker", email = "chris.barker@noaa.gov" },
+]
+keywords = [
+    "cython",
+    "drawing",
+    "graphics",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Cython",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Utilities",
+]
+dependencies = ["numpy"]
+
+[project.urls]
+Homepage = "https://github.com/NOAA-ORR-ERD/py_gd"
+
+[dependency-groups]
+test = ["pytest"]
+build = ["scikit-build-core", "cython", "numpy", "cython-cmake"]
+dev = [{ include-group = "test" }, { include-group = "build"}, "build"]
+
+[tool.scikit-build]
+build-dir = "build"
+
+[tool.scikit-build.metadata.version]
+provider = "scikit_build_core.metadata.regex"
+input = "py_gd/__init__.py"