setup.py

#!/usr/bin/python3
import re
from glob import glob
from os.path import basename, splitext
from pathlib import Path
from typing import List, Union

from setuptools import find_packages, setup

REPOSITORY_ROOT_DIR = Path(__file__).parent
PACKAGE_NAME = "nneve"
SOURCE_DIR = REPOSITORY_ROOT_DIR / "source" / PACKAGE_NAME

# Regular expression is used to extract version from nneve/__init__.py file
VERSION_REGEX = re.compile(r'''__version__.*?=.*?"(\d+\.\d+\.\d+.*?)"''')


def fetch_utf8_content(file_path: Union[str, Path]) -> str:
    """Acquire utf-8 encoded content from file given by file_path."""
    with open(file_path, "r", encoding="utf-8") as file:
        return file.read()


def fetch_requirements(file_path: Union[str, Path]) -> List[str]:
    """Fetch list of required modules from `requirements.txt`."""
    requirements_list: List[str] = []
    with open(file_path, "r", encoding="utf-8") as file:
        for requirement in file.readlines():
            requirement = requirement.strip()
            if requirement.startswith("-r"):
                requirements_list.extend(
                    fetch_requirements(
                        REPOSITORY_ROOT_DIR / requirement.lstrip("-r").strip()
                    )
                )
            else:
                requirements_list.append(requirement)
        return requirements_list


def fetch_package_python_modules(glob_pattern: Union[str, Path]) -> List[str]:
    """Fetch list of names of modules in package selected with glob pattern."""
    return [splitext(basename(path))[0] for path in glob(str(glob_pattern))]


def fetch_version(init_file: Path) -> str:
    """Fetch package version from root `__init__.py` file."""
    with init_file.open("r", encoding="utf-8") as file:
        version_math = VERSION_REGEX.search(file.read())
        assert version_math is not None
        return version_math.group(1)


NAME = PACKAGE_NAME
VERSION = fetch_version(SOURCE_DIR / "__init__.py")
LICENSE_NAME = "LGPL-3.0"
SHORT_DESCRIPTION = (
    "Neural Network Eigenvalue Estimator for quantum oscillator problem."
)
LONG_DESCRIPTION = fetch_utf8_content("README.md")
LONG_DESCRIPTION_CONTENT_TYPE = "text/markdown"
INSTALL_REQUIRES = fetch_requirements(REPOSITORY_ROOT_DIR / "requirements.txt")

AUTHOR = "NNEVE team"
AUTHOR_EMAIL = "argmaster.world@gmail.com"
URL = "https://github.com/Argmaster/nneve"
PACKAGES = find_packages(where="source")

PACKAGE_DIR = {"": "source"}
PACKAGE_PYTHON_MODULES = fetch_package_python_modules(SOURCE_DIR / "*.py")
INCLUDE_PACKAGE_DATA = True
ZIP_SAFE = False
CLASSIFIERS = [
    # complete classifier list: http://pypi.python.org/pypi?%3Aaction=list_classifiers
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Operating System :: Unix",
    "Operating System :: POSIX",
    "Operating System :: Microsoft :: Windows",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.7",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: Implementation :: CPython",
    "Topic :: Utilities",
]
PROJECT_URLS = {
    "GitHub": "https://github.com/Argmaster/nneve",
}
KEYWORDS = [
    "python-3",
    "python-3.7",
    "python-3.8",
    "python-3.9",
    "python-3.10",
]
EXTRAS_REQUIRE = {
    "dev": fetch_requirements(REPOSITORY_ROOT_DIR / "requirements-dev.txt"),
}
ENTRY_POINTS = {"console_scripts": ["nneve=nneve.__main__:main"]}
PYTHON_REQUIREMENTS = ">=3.7"

INTERNAL_LIB_DIR = Path("./build/source/internal/")

MODULES = []
PACKAGE_DATA = {}


def run_setup_script():
    """Run setup(...) with all constants set in this module."""
    setup(
        name=NAME,
        version=VERSION,
        license=LICENSE_NAME,
        description=SHORT_DESCRIPTION,
        long_description=LONG_DESCRIPTION,
        long_description_content_type=LONG_DESCRIPTION_CONTENT_TYPE,
        author=AUTHOR,
        author_email=AUTHOR_EMAIL,
        url=URL,
        packages=PACKAGES,
        package_dir=PACKAGE_DIR,
        py_modules=PACKAGE_PYTHON_MODULES,
        include_package_data=INCLUDE_PACKAGE_DATA,
        zip_safe=ZIP_SAFE,
        classifiers=CLASSIFIERS,
        project_urls=PROJECT_URLS,
        keywords=KEYWORDS,
        python_requires=PYTHON_REQUIREMENTS,
        install_requires=INSTALL_REQUIRES,
        extras_require=EXTRAS_REQUIRE,
        entry_points=ENTRY_POINTS,
        ext_modules=MODULES,
        package_data=PACKAGE_DATA,
    )


if __name__ == "__main__":
    run_setup_script()