kickpy/setup.py at main · pavalso/kickpy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
import os # Used to obtain Git version information. See calculate_version function.
import os.path  # Used to construct file paths.

from setuptools import setup, find_packages


version_path = os.path.join("src", "kickpy", "VERSION")

with open("requirements.txt") as f:
    requirements = f.read().splitlines()

def generate_meta():
    """
    Generates the meta information for the package.
    This function reads the meta information from the meta module and returns it.
    """
    return {
        "version": calculate_version(),
        "author": "Pavalso",
        "license": "MIT",
        "description": "A Python library for interacting with the Kick streaming platform API.",
        "package_name": "pykick",
    }

def calculate_version():
    """
    Calculates the version of the package using Git.
    This function checks if the Git repository is currently tagged.
    If a tag is found, it returns the tag as the version.
    If no tags are found, returns current commit hash + version.
    If no repository is found, returns
    """
    current_tag = os.popen("git describe --exact-match --tags").read().strip()
    closest_tag = os.popen("git describe --tags --abbrev=0").read().strip()
    commit_hash = os.popen("git rev-parse --short HEAD").read().strip()
    commit_count = os.popen("git rev-list --all --count").read().strip()

    if os.path.isfile(version_path):
        # If the VERSION file exists, read the version from it.
        with open(version_path, "r") as version_file:
            version_line = version_file.read().strip()
            if version_line:
                __version__ = version_line
    else:
        # If the VERSION file does not exist, use a default version.
        __version__ = "0.0.0+unknown"

    version = f"{__version__}+{commit_hash}.{commit_count}"

    if not current_tag  and not closest_tag and not commit_hash:
        # If no Git information is available, fallback to the default version.
        return __version__

    elif current_tag:
        # If the current commit is tagged, return the tag as the version.
        version = current_tag

    elif closest_tag:
        # If no exact tag, returns the closest tag + commit hash.
        version = f"{closest_tag}+{commit_hash}.{commit_count}"

    # If no tags are found, return the commit hash + commit count.
    return version

meta = generate_meta()

with open(version_path, "w") as version_file:
    version_file.write(meta["version"])

setup(
    name=meta["package_name"],
    version=meta["version"],
    author=meta["author"],
    description=meta["description"],
    long_description=open("README.md", encoding="utf-8").read(),
    long_description_content_type="text/markdown",
    url="https://github.com/pavalso/kick.py",
    packages=find_packages(where="src"),
    package_dir={"": "src"},
    install_requires=requirements,
    classifiers=[
        "Development Status :: 4 - Beta",
        "Intended Audience :: Developers",
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
    ],
    python_requires=">=3.10",
    license=meta["license"],
    keywords="kick streaming python api library",
    project_urls={
        "Documentation": "https://kickpy.readthedocs.io",
        "Source": "https://github.com/pavalso/kick.py",
    },
    include_package_data=True,
)