setup.py

# ================================================================================= #
# MIT License                                                                       #
#                                                                                   #
# Copyright(c) 2020 Marco Tröster                                                   #
#                                                                                   #
# Permission is hereby granted, free of charge, to any person obtaining a copy      #
# of this software and associated documentation files (the "Software"), to deal     #
# in the Software without restriction, including without limitation the rights      #
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell         #
# copies of the Software, and to permit persons to whom the Software is             #
# furnished to do so, subject to the following conditions:                          #
#                                                                                   #
# The above copyright notice and this permission notice shall be included in all    #
# copies or substantial portions of the Software.                                   #
#                                                                                   #
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR        #
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,          #
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE       #
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER            #
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,     #
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE     #
# SOFTWARE.                                                                         #
# ================================================================================= #

# =============================================
#      SETUP CHESSLIB PYTHON EXTENSION
# =============================================


# import python C-lib extension tools
from setuptools import setup, Extension
import sys, os, io, subprocess
# TODO: try the alternative scikit build tools allowing for the integration of CMake builds


# define configurable variables
PACKAGE_NAME = "chesslib"
DESCRIPTION = "Python3 library for efficient chess draw-gen functions"
PROJECT_URL = "https://github.com/Bonifatius94/ChessLib.Py"
AUTHOR = "Marco Tröster"
AUTHOR_EMAIL = "marco@troester-gmbh.de"
PYTHON_VERSION = '>=3.0.0'
DEPENDENCIES = ['numpy']


def load_package_version():

    # initialize version with new generated version
    import update_version
    version = update_version.generate_package_version()

    # load existing version file or write a new version file with the generated version
    if os.path.isfile("version"):
        with open("version", "r") as f:
            version = f.read()
    else:
        with open("version", "w") as f:
            f.write(version)

    return version


def load_readme_description():

    long_description = None
    here = os.path.abspath(os.path.dirname(__file__))

    try:
        with io.open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
            long_description = '\n' + f.read()
    except FileNotFoundError:
        long_description = DESCRIPTION

    return long_description


# declare main function
def main():

    # install all packages from requirements.txt (makes sure that numpy is installed)
    #subprocess.check_call([sys.executable, "-m", "pip", "install", "-r", "requirements.txt"])

    # reload system path variable to find installed packages
    import site
    from importlib import reload
    reload(site)

    # generate a unique package version
    version = load_package_version()

    # define source files to compile as python C-lib extension module
    source_files = [
        "chesslib/src/chesslibmodule.c",
        "chesslib/src/chessboard.c",
        "chesslib/src/chesspiece.c",
        "chesslib/src/chessposition.c",
        "chesslib/src/chessdraw.c",
        "chesslib/src/chessdrawgen.c",
        "chesslib/src/chesspieceatpos.c",
        "chesslib/src/chessgamestate.c"
    ]

    # define extension module settings (for cross-plattform builds)
    import numpy as np
    chesslib_module = Extension("chesslib",
                                include_dirs = ["chesslib/include", np.get_include()],
                                sources = source_files,
                                define_macros = [("CHESSLIB_PACKAGE_VERSION", '"{}"'.format(version))],
                                language = 'c')

    # setup python extension module (compilation, packaging, deployment, ...)
    setup(name = PACKAGE_NAME,
          version = version,
          description = DESCRIPTION,
          long_description = load_readme_description(),
          long_description_content_type = 'text/markdown',
          url = PROJECT_URL,
          author = AUTHOR,
          author_email = AUTHOR_EMAIL,
          python_requires = PYTHON_VERSION,
          install_requires = DEPENDENCIES,
          ext_modules = [chesslib_module],
          setup_requires=['wheel'])


# invoke main function
if __name__ == "__main__":
    main()


# =============================================
#         Marco Tröster, 2020-11-13
# =============================================