setup.py

"""A setuptools based setup module.
See:
https://packaging.python.org/guides/distributing-packages-using-setuptools/
https://github.com/pypa/sampleproject

Adopted from TorchVision, see:
https://github.com/pytorch/vision/blob/master/setup.py
"""
from pathlib import Path
import subprocess
from setuptools import setup, find_packages

PATH_ROOT = Path(__file__).parent.resolve()
VERSION = "0.4.0a0"

PACKAGE_NAME = 'yolort'
sha = 'Unknown'

try:
    sha = subprocess.check_output(['git', 'rev-parse', 'HEAD'], cwd=PATH_ROOT).decode('ascii').strip()
except Exception:
    pass


def write_version_file():
    version_path = PATH_ROOT / PACKAGE_NAME / 'version.py'
    with open(version_path, 'w') as f:
        f.write(f"__version__ = '{VERSION}'\n")
        f.write(f"git_version = {repr(sha)}\n")
        f.write("from torchvision.extension import _check_cuda_version\n")
        f.write("if _check_cuda_version() > 0:\n")
        f.write("    cuda = _check_cuda_version()\n")


def load_requirements(path_dir=PATH_ROOT, file_name='requirements.txt', comment_char='#'):
    with open(path_dir / file_name, 'r', encoding="utf-8", errors="ignore") as file:
        lines = [ln.rstrip() for ln in file.readlines() if not ln.startswith('#')]
    reqs = []
    for ln in lines:
        if comment_char in ln:  # filer all comments
            ln = ln[:ln.index(comment_char)].strip()
        if ln.startswith('http'):  # skip directly installed dependencies
            continue
        if ln:  # if requirement is not empty
            reqs.append(ln)
    return reqs


if __name__ == "__main__":
    print("Building wheel {}-{}".format(PACKAGE_NAME, VERSION))

    write_version_file()

    # Get the long description from the README file
    long_description = (PATH_ROOT / 'README.md').read_text(encoding='utf-8')

    setup(
        name=PACKAGE_NAME,
        version=VERSION,
        description="Yet Another YOLOv5 and its Additional Runtime Stack",
        author="Zhiqiang Wang",
        author_email="me@zhiqwang.com",
        long_description=long_description,
        long_description_content_type="text/markdown",
        url="https://github.com/zhiqwang/yolov5-rt-stack",
        license="GPL-3.0",
        packages=find_packages(exclude=['test', 'deployment', 'notebooks']),

        zip_safe=False,
        classifiers=[
            # Operation system
            'Operating System :: OS Independent',
            # How mature is this project? Common values are
            #   3 - Alpha
            #   4 - Beta
            #   5 - Production/Stable
            'Development Status :: 4 - Beta',
            # Indicate who your project is intended for
            'Intended Audience :: Developers',
            # Topics
            'Topic :: Education',
            'Topic :: Scientific/Engineering',
            'Topic :: Scientific/Engineering :: Artificial Intelligence',
            'Topic :: Scientific/Engineering :: Image Recognition',
            # Pick your license as you wish
            'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
            # Specify the Python versions you support here. In particular, ensure
            # that you indicate whether you support Python 2, Python 3 or both.
            'Programming Language :: Python :: 3',
            'Programming Language :: Python :: 3.6',
            'Programming Language :: Python :: 3.7',
            'Programming Language :: Python :: 3.8',
            'Programming Language :: Python :: 3.9',
        ],
        install_requires=load_requirements(),
        # This field adds keywords for your project which will appear on the
        # project page. What does your project relate to?
        #
        # Note that this is a list of additional keywords, separated
        # by commas, to be used to assist searching for the distribution in a
        # larger catalog.
        keywords='machine-learning, deep-learning, ml, pytorch, YOLO, object-detection, YOLOv5, TorchScript',
        # Specify which Python versions you support. In contrast to the
        # 'Programming Language' classifiers above, 'pip install' will check this
        # and refuse to install the project if the version does not match. See
        # https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
        python_requires='>=3.6, <4',
        # List additional URLs that are relevant to your project as a dict.
        #
        # This field corresponds to the "Project-URL" metadata fields:
        # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
        #
        # Examples listed include a pattern for specifying where the package tracks
        # issues, where the source is hosted, where to say thanks to the package
        # maintainers, and where to support the project financially. The key is
        # what's used to render the link text on PyPI.
        project_urls={  # Optional
            'Bug Reports': 'https://github.com/zhiqwang/yolov5-rt-stack/issues',
            'Funding': 'https://zhiqwang.com',
            'Source': 'https://github.com/zhiqwang/yolov5-rt-stack/',
        },
    )