setup.py

"""
Setup.py file to build and install package
"""
import codecs
import os
from setuptools import setup, find_packages


def open_local(paths, mode="r", encoding="utf8"):
    """
    Open local package file
    :param paths: list of paths to file
    :param mode: read, write, ...
    :param encoding: Encoding
    :return: file object
    """
    path = os.path.join(os.path.abspath(os.path.dirname(__file__)), *paths)
    return codecs.open(path, mode, encoding)


def get_value_from_package_info(line, value, old_value):
    """
    Get value from text line
    :param line: file text line
    :param value: value to parse
    :param old_value: if value has already founded
    :return:
    """
    if old_value:
        return old_value
    if line.startswith(value):
        _, val = line.split('=')
        return val.strip().replace("'", '')
    return None


PACKAGE_NAME = "replay_wizard"

PROJECT_URLS = {
    'Documentation': 'https://replaywizard.craftsman.lol/',
    'Source': 'https://github.com/quillcraftsman/replay-wizard',
    'Tracker': 'https://github.com/quillcraftsman/replay-wizard/issues',
    'Release notes': 'https://github.com/quillcraftsman/replay-wizard/releases',
    'Changelog': 'https://github.com/quillcraftsman/replay-wizard/releases',
    'Download': 'https://pypi.org/project/replay-wizard/',
}

with open_local([PACKAGE_NAME, "package.py"]) as fp:
    package_pypi_name, package_version, package_status = None, None, None
    for file_line in fp:
        package_pypi_name = get_value_from_package_info(file_line, 'name', package_pypi_name)
        package_version = get_value_from_package_info(file_line, 'version', package_version)
        package_status = get_value_from_package_info(file_line, 'status', package_status)

    if not (package_pypi_name and package_version and package_status):
        raise RuntimeError("Unable to determine Package Info.")

# allow setup.py to be run from any path
# os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))

def read(filename):
    """
    read some file
    """
    with open(filename, "r", encoding="utf-8") as file:
        return file.read()


def get_entrypoint(script_name, function_name):
    """
    Get console entrypoint
    """
    return f"{script_name} = replay_wizard.__main__:{function_name}"


setup(
    name=package_pypi_name,
    version=package_version,
    packages=find_packages(
        include=[PACKAGE_NAME, f'{PACKAGE_NAME}.*']
    ),

    include_package_data=True,
    license="MIT",
    description="ReplayWizard is a powerful automation tool designed to streamline "
                "your workflow by capturing and replaying your interactions with your computer",
    long_description=read("README.md"),
    long_description_content_type="text/markdown",
    url="https://github.com/quillcraftsman/replay-wizard",
    author="quillcraftsman",
    author_email="quill@craftsman.lol",
    keywords=[
        "python",
        "home-automation",
        "automation",
        "artificial-intelligence",
        "replayer",
        "capturing",
    ],
    install_requires=[
        'pynput==1.7.6',
        'pydantic==2.6.3',
    ],
    python_requires=">=3",
    classifiers=[
        f'Development Status :: {package_status}',
        "Intended Audience :: End Users/Desktop",
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3",
        'Environment :: Console',
        "Operating System :: OS Independent",
        "Topic :: Adaptive Technologies",
        "Topic :: Home Automation",
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
    ],
    project_urls=PROJECT_URLS,
    entry_points={"console_scripts": [
        get_entrypoint("wizard-capture", "capture"),
        get_entrypoint("wizard-replay", "replay"),
        get_entrypoint("wizard-combine", "combine"),
        get_entrypoint("wizard-list", "sequence_list"),
    ]},
)