Enable building Python packages for PyPI distribution

.gitignore

@@ -5,12 +5,6 @@
 *_wrap.c
 snippets/
 
-# Binary files
-mergerepo_c
-createrepo_c
-modifyrepo_c
-sqliterepo_c
-
 # Packages and tarball
 createrepo*.rpm
 python-createrepo*.rpm
@@ -28,6 +22,13 @@ _CPack_Packages/
 src/version.h
 src/createrepo_c.pc
 src/deltarpms.h
+src/python/createrepo_c/
+_skbuild/
+
+# Python distribution stuff
+dist/
+MANIFEST
+*.egg-info/
 
 # Devel stuff
 notes

AUTHORS

@@ -8,3 +8,4 @@ Jarek Polok <[email protected]>
 Neal Gompa <[email protected]>
 Ralph Bean <[email protected]>
 Frank Schreiner <[email protected]>
+Daniel Alley <[email protected]>

CMakeLists.txt

@@ -1,5 +1,5 @@
 PROJECT (createrepo_c C)
-CMAKE_MINIMUM_REQUIRED (VERSION 2.6)
+CMAKE_MINIMUM_REQUIRED (VERSION 2.8)
 
 set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99")
 set (CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS} -ggdb -g -Wall -Wextra -Og")
@@ -14,6 +14,14 @@ IF(CMAKE_BUILD_TYPE AND CMAKE_BUILD_TYPE STREQUAL "DEBUG")
 ENDIF()
 
 
+option(BUILD_LIBCREATEREPO_C_SHARED "Build libcreaterepo_c as a shared library" ON)
+if(NOT BUILD_LIBCREATEREPO_C_SHARED)
+  set(CMAKE_POSITION_INDEPENDENT_CODE 1)
+endif()
+
+option(CREATEREPO_C_INSTALL_DEVELOPMENT "Install createrepo_c development files." ON)
+option(CREATEREPO_C_INSTALL_MANPAGES "Install createrepo_c man-pages." ON)
+
 # Add path with own cmake modules
 
 INCLUDE_DIRECTORIES (${CMAKE_SOURCE_DIR})
@@ -39,6 +47,7 @@ find_package(ZLIB REQUIRED)
 
 include_directories(${GLIB2_INCLUDE_DIRS})
 include_directories(${LIBXML2_INCLUDE_DIR})
+include_directories(${OPENSSL_INCLUDE_DIR})
 
 
 IF (RPM_PATH)
@@ -126,20 +135,23 @@ endif()
 
 # Other files
 
-pkg_check_modules(BASHCOMP bash-completion)
-if (BASHCOMP_FOUND)
-    execute_process(COMMAND ${PKG_CONFIG_EXECUTABLE} --variable=completionsdir bash-completion OUTPUT_VARIABLE BASHCOMP_DIR OUTPUT_STRIP_TRAILING_WHITESPACE)
-    message("Bash completion directory: ${BASHCOMP_DIR}")
-    INSTALL(FILES createrepo_c.bash DESTINATION ${BASHCOMP_DIR} RENAME createrepo_c)
-    INSTALL(CODE "
-        execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink createrepo_c \$ENV{DESTDIR}${BASHCOMP_DIR}/mergerepo_c)
-        execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink createrepo_c \$ENV{DESTDIR}${BASHCOMP_DIR}/modifyrepo_c)
-        execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink createrepo_c \$ENV{DESTDIR}${BASHCOMP_DIR}/sqliterepo_c)
-        ")
-ELSE (BASHCOMP_FOUND)
-    INSTALL(FILES createrepo_c.bash DESTINATION "/etc/bash_completion.d")
-    message("Bash completion directory: /etc/bash_completion.d")
-endif (BASHCOMP_FOUND)
+OPTION(ENABLE_BASHCOMP "Install Bash autocompletions?" ON)
+IF (ENABLE_BASHCOMP)
+    pkg_check_modules(BASHCOMP bash-completion)
+    IF (BASHCOMP_FOUND)
+        execute_process(COMMAND ${PKG_CONFIG_EXECUTABLE} --variable=completionsdir bash-completion OUTPUT_VARIABLE BASHCOMP_DIR OUTPUT_STRIP_TRAILING_WHITESPACE)
+        message("Bash completion directory: ${BASHCOMP_DIR}")
+        INSTALL(FILES createrepo_c.bash DESTINATION ${BASHCOMP_DIR} RENAME createrepo_c)
+        INSTALL(CODE "
+            execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink createrepo_c \$ENV{DESTDIR}${BASHCOMP_DIR}/mergerepo_c)
+            execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink createrepo_c \$ENV{DESTDIR}${BASHCOMP_DIR}/modifyrepo_c)
+            execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink createrepo_c \$ENV{DESTDIR}${BASHCOMP_DIR}/sqliterepo_c)
+            ")
+    ELSEIF (BASHCOMP_FOUND)
+        INSTALL(FILES createrepo_c.bash DESTINATION "/etc/bash_completion.d")
+        message("Bash completion directory: /etc/bash_completion.d")
+    ENDIF (BASHCOMP_FOUND)
+ENDIF (ENABLE_BASHCOMP)
 
 
 # Gen manpage

doc/CMakeLists.txt

@@ -8,9 +8,11 @@ if(DOXYGEN_FOUND)
         COMMENT "Building C API documentation with Doxygen" VERBATIM)
 endif(DOXYGEN_FOUND)
 
-INSTALL(FILES createrepo_c.8 mergerepo_c.8 modifyrepo_c.8 sqliterepo_c.8
-        DESTINATION share/man/man8
-        COMPONENT bin)
+IF(CREATEREPO_C_INSTALL_MANPAGES)
+    INSTALL(FILES createrepo_c.8 mergerepo_c.8 modifyrepo_c.8 sqliterepo_c.8
+            DESTINATION share/man/man8
+            COMPONENT bin)
+ENDIF(CREATEREPO_C_INSTALL_MANPAGES)
 
 ADD_CUSTOM_TARGET (doc)
 ADD_DEPENDENCIES (doc doc-python doc-c)

pyproject.toml

@@ -0,0 +1,2 @@
+[build-system]
+requires = ["setuptools", "wheel", "scikit-build"]

requirements-dev.txt

@@ -0,0 +1,3 @@
+setuptools
+wheel
+scikit-build

setup.py

@@ -0,0 +1,56 @@
+from skbuild import setup
+
+version = '{major}.{minor}.{patch}'
+
+with open('VERSION.cmake', 'r+') as version_file:
+    version_text = version_file.read()
+    # split on lines, remove empty lines
+    lines = filter(len, version_text.split('\n'))
+    # parse out digit characters from the line, convert to int
+    numbers = [int("".join(filter(str.isdigit, line))) for line in lines]
+    # build version string
+    version = version.format(major=numbers[0], minor=numbers[1], patch=numbers[2])
+
+setup(
+    name='createrepo_c',
+    description='C implementation of createrepo',
+    version=version,
+    license='GPLv2',
+    author='RPM Software Management',
+    author_email='',
+    url='https://github.com/rpm-software-management',
+    classifiers=(
+        'License :: OSI Approved :: GNU General Public License v2 (GPLv2)',
+        'Operating System :: POSIX :: Linux',
+        'Programming Language :: C',
+        'Topic :: System :: Software Distribution',
+        'Topic :: System :: Systems Administration',
+        "Programming Language :: Python :: 2",
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+    ),
+    packages=['createrepo_c'],
+    package_dir={
+        'createrepo_c': 'src/python/createrepo_c'
+    },
+    cmake_args=[
+        '-DBIN_INSTALL_DIR:PATH=src/python/createrepo_c/data/bin',
+        '-DBUILD_LIBCREATEREPO_C_SHARED:BOOL=OFF',
+        '-DCREATEREPO_C_INSTALL_DEVELOPMENT:BOOL=OFF',
+        '-DCREATEREPO_C_INSTALL_MANPAGES:BOOL=OFF',
+        '-DENABLE_BASHCOMP:BOOL=OFF',
+    ],
+    cmake_languages=['C'],
+    entry_points={
+        'console_scripts': [
+            'createrepo_c=createrepo_c:createrepo_c',
+            'mergerepo_c=createrepo_c:mergerepo_c',
+            'modifyrepo_c=createrepo_c:modifyrepo_c',
+            'sqliterepo_c=createrepo_c:sqliterepo_c'
+        ]
+    },
+)

src/CMakeLists.txt

@@ -56,7 +56,12 @@ SET(headers
     xml_file.h
     xml_parser.h)
 
-ADD_LIBRARY(libcreaterepo_c SHARED ${createrepo_c_SRCS})
+IF (BUILD_LIBCREATEREPO_C_SHARED)
+  SET (createrepo_c_library_type SHARED)
+ELSE ()
+  SET (createrepo_c_library_type STATIC)
+ENDIF ()
+ADD_LIBRARY(libcreaterepo_c ${createrepo_c_library_type} ${createrepo_c_SRCS})
 TARGET_LINK_LIBRARIES(libcreaterepo_c ${BZIP2_LIBRARIES})
 TARGET_LINK_LIBRARIES(libcreaterepo_c ${CURL_LIBRARY})
 TARGET_LINK_LIBRARIES(libcreaterepo_c ${EXPAT_LIBRARIES})
@@ -110,16 +115,34 @@ CONFIGURE_FILE("deltarpms.h.in" "${CMAKE_CURRENT_SOURCE_DIR}/deltarpms.h" @ONLY)
 IF (CMAKE_SIZEOF_VOID_P MATCHES "8")
     SET (LIB_SUFFIX "64")
 ENDIF (CMAKE_SIZEOF_VOID_P MATCHES "8")
+
 SET (LIB_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/lib${LIB_SUFFIX}")
+IF (CREATEREPO_C_INSTALL_DEVELOPMENT OR "${createrepo_c_library_type}" STREQUAL "SHARED")
+    INSTALL(
+        TARGETS libcreaterepo_c
+        RUNTIME DESTINATION ${LIB_INSTALL_DIR} COMPONENT RuntimeLibraries
+        LIBRARY DESTINATION ${LIB_INSTALL_DIR} COMPONENT RuntimeLibraries
+        ARCHIVE DESTINATION ${LIB_INSTALL_DIR} COMPONENT Development
+        )
+ENDIF (CREATEREPO_C_INSTALL_DEVELOPMENT OR "${createrepo_c_library_type}" STREQUAL "SHARED")
+
+IF (CREATEREPO_C_INSTALL_DEVELOPMENT)
+    INSTALL(FILES ${headers} DESTINATION "include/createrepo_c")
+    INSTALL(FILES "createrepo_c.pc" DESTINATION "${LIB_INSTALL_DIR}/pkgconfig")
+ENDIF (CREATEREPO_C_INSTALL_DEVELOPMENT)
 
-INSTALL(FILES ${headers} DESTINATION "include/createrepo_c")
-INSTALL(FILES "createrepo_c.pc" DESTINATION "${LIB_INSTALL_DIR}/pkgconfig")
-INSTALL(TARGETS libcreaterepo_c LIBRARY DESTINATION ${LIB_INSTALL_DIR})
-INSTALL(TARGETS createrepo_c DESTINATION bin/)
-INSTALL(TARGETS mergerepo_c DESTINATION bin/)
-INSTALL(TARGETS modifyrepo_c DESTINATION bin/)
-INSTALL(TARGETS sqliterepo_c DESTINATION bin/)
+IF (NOT DEFINED BIN_INSTALL_DIR)
+    SET(BIN_INSTALL_DIR "bin/")
+ENDIF (NOT DEFINED BIN_INSTALL_DIR)
+INSTALL(
+    TARGETS
+        createrepo_c
+        mergerepo_c
+        modifyrepo_c
+        sqliterepo_c
+    RUNTIME DESTINATION ${BIN_INSTALL_DIR} COMPONENT Runtime
+    )
 
 IF (ENABLE_PYTHON)
-ADD_SUBDIRECTORY(python)
+    ADD_SUBDIRECTORY(python)
 ENDIF (ENABLE_PYTHON)

src/python/CMakeLists.txt

@@ -1,23 +1,25 @@
-if (${PYTHON_DESIRED} STREQUAL "2")
-    unset(PYTHON_LIBRARY)
-    unset(PYTHON_INCLUDE_DIR)
-    unset(PYTHON_EXECUTABLE)
-    unset(PYTHON_LIBRARY CACHE)
-    unset(PYTHON_INCLUDE_DIR CACHE)
-    unset(PYTHON_EXECUTABLE CACHE)
-    FIND_PACKAGE(PythonLibs 2)
-    FIND_PACKAGE(PythonInterp 2 REQUIRED)
-else()
-    SET(Python_ADDITIONAL_VERSIONS 3.0)
-    unset(PYTHON_LIBRARY)
-    unset(PYTHON_INCLUDE_DIR)
-    unset(PYTHON_EXECUTABLE)
-    unset(PYTHON_LIBRARY CACHE)
-    unset(PYTHON_INCLUDE_DIR CACHE)
-    unset(PYTHON_EXECUTABLE CACHE)
-    FIND_PACKAGE(PythonLibs 3.0)
-    FIND_PACKAGE(PythonInterp 3.0 REQUIRED)
-endif()
+if (NOT SKBUILD)
+    if (${PYTHON_DESIRED} STREQUAL "2")
+        unset(PYTHON_LIBRARY)
+        unset(PYTHON_INCLUDE_DIR)
+        unset(PYTHON_EXECUTABLE)
+        unset(PYTHON_LIBRARY CACHE)
+        unset(PYTHON_INCLUDE_DIR CACHE)
+        unset(PYTHON_EXECUTABLE CACHE)
+        FIND_PACKAGE(PythonLibs 2)
+        FIND_PACKAGE(PythonInterp 2 REQUIRED)
+    else ()
+        SET(Python_ADDITIONAL_VERSIONS 3.0)
+        unset(PYTHON_LIBRARY)
+        unset(PYTHON_INCLUDE_DIR)
+        unset(PYTHON_EXECUTABLE)
+        unset(PYTHON_LIBRARY CACHE)
+        unset(PYTHON_INCLUDE_DIR CACHE)
+        unset(PYTHON_EXECUTABLE CACHE)
+        FIND_PACKAGE(PythonLibs 3.0)
+        FIND_PACKAGE(PythonInterp 3.0 REQUIRED)
+    endif ()
+endif (NOT SKBUILD)
 
 EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c "from sys import stdout; from distutils import sysconfig; stdout.write(sysconfig.get_python_lib(True))" OUTPUT_VARIABLE PYTHON_INSTALL_DIR)
 INCLUDE_DIRECTORIES (${PYTHON_INCLUDE_PATH})
@@ -28,12 +30,6 @@ set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fno-strict-aliasing")
 set (CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -fno-strict-aliasing")
 set (CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -fno-strict-aliasing")
 
-IF (${CMAKE_VERSION} VERSION_LESS "2.8.0")
-    CONFIGURE_FILE(__init__.py "src/python/createrepo_c/__init__.py" COPYONLY)
-ELSE()
-    FILE(COPY __init__.py DESTINATION ./createrepo_c/)
-ENDIF()
-
 SET (createrepo_cmodule_SRCS
      checksum-py.c
      compression_wrapper-py.c
@@ -66,8 +62,23 @@ TARGET_LINK_LIBRARIES(_createrepo_c libcreaterepo_c)
 TARGET_LINK_LIBRARIES(_createrepo_c
                         ${EXPAT_LIBRARIES}
                         ${CURL_LIBRARY}
-                        ${PYTHON_LIBRARY}
                      )
 
-INSTALL(FILES __init__.py DESTINATION ${PYTHON_INSTALL_DIR}/createrepo_c)
-INSTALL(TARGETS _createrepo_c LIBRARY DESTINATION ${PYTHON_INSTALL_DIR}/createrepo_c)
+IF (SKBUILD)
+    find_package(PythonExtensions REQUIRED)
+    python_extension_module(_createrepo_c)
+ELSE ()
+    TARGET_LINK_LIBRARIES(_createrepo_c ${PYTHON_LIBRARY})
+ENDIF ()
+
+IF (NOT SKBUILD)
+    FILE(COPY createrepo_c/__init__.py DESTINATION createrepo_c)
+ENDIF()
+
+IF (SKBUILD)
+    INSTALL(FILES createrepo_c/__init__.py DESTINATION src/python/createrepo_c)
+    INSTALL(TARGETS _createrepo_c LIBRARY DESTINATION src/python/createrepo_c)
+ELSE ()
+    INSTALL(FILES createrepo_c/__init__.py DESTINATION ${PYTHON_INSTALL_DIR}/createrepo_c)
+    INSTALL(TARGETS _createrepo_c LIBRARY DESTINATION ${PYTHON_INSTALL_DIR}/createrepo_c)
+ENDIF ()

src/python/__init__.py → src/python/createrepo_c/__init__.py

@@ -1,6 +1,10 @@
 """
 """
 
+import os
+import subprocess
+import sys
+
 from . import _createrepo_c
 from ._createrepo_c import *
 
@@ -326,3 +330,37 @@ def decompress_file(src, dst, comtype, stat=None):
 compression_suffix  = _createrepo_c.compression_suffix
 detect_compression  = _createrepo_c.detect_compression
 compression_type    = _createrepo_c.compression_type
+
+
+# If we have been built as a Python package, e.g. "setup.py", this is where the binaries
+# will be located.
+_DATA_DIR = os.path.join(os.path.dirname(__file__), 'data')
+
+# Where we will look for the binaries. Default to looking on the system PATH.
+_BIN_DIR = ""
+
+# If the following test succeeds, then look for binaries in the Python pkg "data" location.
+# If not, we probably were not built as a Python package (e.g. RPM, "cmake ..; make").
+# In that case, let's just assume that the binary will be on the PATH somewhere.
+if os.path.exists(_DATA_DIR):
+    _BIN_DIR = os.path.join(_DATA_DIR, 'bin')
+
+
+def _program(name, args):
+    return subprocess.call([os.path.join(_BIN_DIR, name)] + args)
+
+
+def createrepo_c():
+    raise SystemExit(_program('createrepo_c', sys.argv[1:]))
+
+
+def mergerepo_c():
+    raise SystemExit(_program('mergerepo_c', sys.argv[1:]))
+
+
+def modifyrepo_c():
+    raise SystemExit(_program('modifyrepo_c', sys.argv[1:]))
+
+
+def sqliterepo_c():
+    raise SystemExit(_program('sqliterepo_c', sys.argv[1:]))