setup.py

""" Project setup script """
import os
import re

from setuptools import setup, find_packages

with open(os.path.join("requirements", "base.txt")) as f:
    requirements = f.read().splitlines()

with open("README.md", "r") as fh:
    long_description = fh.read()


def read(rel_path) -> str:
    """
    Reads in a file, relative to this one
    :param rel_path: the relative path to read
    :return: the file contents, as a string
    """
    here = os.path.abspath(os.path.dirname(__file__))
    # intentionally *not* adding an encoding option to open, See:
    #   https://github.com/pypa/virtualenv/issues/201#issuecomment-3145690
    with open(os.path.join(here, rel_path), "r") as file_obj:
        return file_obj.read()


def check_semver(version_string: str) -> bool:
    """
    Check a given string is in semver format
    :return: True if in correct format, otherwise False
    """
    semver_pattern = r"^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
    return re.match(semver_pattern, version_string) is not None


def get_version(rel_path) -> str:
    """
    Get the version from the file specified by the
    relative path. This reads the text directly, rather
    than importing the file
    :param rel_path: the relative path to read
    :return: the version string in semver e.g. 0.1.3
    :raises: RuntimeError if the version is not found, or it
    is not in semver format
    """

    for line in read(rel_path).splitlines():
        if line.startswith("__version__"):
            delim = '"' if '"' in line else "'"
            version = line.split(delim)[1]
            if not check_semver(version):
                raise RuntimeError(f"Version: {version} is not " "in semver format")
            return version
    raise RuntimeError("Unable to find version string.")


setup(
    name="asldro",
    version=get_version("src/asldro/__init__.py"),
    author="Gold Standard Phantoms",
    author_email="info@goldstandardphantoms.com",
    description="ASL Digital Reference Object",
    long_description=long_description,
    long_description_content_type="text/markdown",
    license="MIT",
    url="https://github.com/gold-standard-phantoms/asldro",
    project_urls={
        "Documentation": "https://asldro.readthedocs.io/",
        "Code": "https://github.com/gold-standard-phantoms/asldro",
        "Issue tracker": "https://github.com/gold-standard-phantoms/asldro/issues",
    },
    packages=find_packages(where="src"),
    package_dir={"": "src"},
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        "Intended Audience :: Science/Research",
        "Topic :: Scientific/Engineering",
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires=">=3.7",
    install_requires=requirements,
    include_package_data=True,
    entry_points={"console_scripts": ["asldro=asldro.cli:main"]},
)