setup.py

# Setup script for the Switchboard Python module

# Copyright (c) 2024 Zero ASIC Corporation
# This code is licensed under Apache License 2.0 (see LICENSE for details)

from setuptools import setup, find_packages
from pybind11.setup_helpers import Pybind11Extension, build_ext

__version__ = "0.2.20"

#################################################################################
# parse_reqs, long_desc from https://github.com/siliconcompiler/siliconcompiler #
#################################################################################


def parse_reqs():
    '''Parse out each requirement category from requirements.txt'''
    install_reqs = []
    extras_reqs = {}
    current_section = None  # default to install

    with open('requirements.txt', 'r') as reqs_file:
        for line in reqs_file.readlines():
            line = line.rstrip('\n')
            if line.startswith('#:'):
                # strip off '#:' prefix to read extras name
                current_section = line[2:]
                if current_section not in extras_reqs:
                    extras_reqs[current_section] = []
            elif not line or line.startswith('#'):
                # skip blanks and comments
                continue
            elif current_section is None:
                install_reqs.append(line)
            else:
                extras_reqs[current_section].append(line)

    return install_reqs, extras_reqs


with open("README.md", "r", encoding="utf-8") as readme:
    long_desc = readme.read()

########################################################################
########################################################################


# the pybind module is built as _switchboard that is imported
# into the module called "switchboard".  this will allow us
# to implement some features in pure Python in the future

ext_modules = [
    Pybind11Extension(
        "_switchboard",
        ["python/switchboard_pybind.cc"],
        include_dirs=['switchboard/cpp']
    ),
]

# determine installation requirements

install_reqs, extras_req = parse_reqs()

setup(
    name="switchboard-hw",
    description="A low-latency communication library for RTL simulation and emulation.",
    long_description=long_desc,
    long_description_content_type="text/markdown",
    license='Apache License 2.0',
    author="Zero ASIC",
    url="https://github.com/zeroasiccorp/switchboard",
    project_urls={
        "Documentation": "https://zeroasiccorp.github.io/switchboard/",
        "Bug Tracker": "https://github.com/zeroasiccorp/switchboard/issues"
    },
    version=__version__,
    packages=find_packages(),
    include_package_data=True,
    python_requires=">=3.7",
    install_requires=install_reqs,
    extras_require=extras_req,
    ext_modules=ext_modules,
    entry_points={
        'console_scripts': [
            'sbtcp=switchboard.sbtcp:main',
            'switchboard=switchboard.switchboard:main'
        ],
        'pytest11': [
            'switchboard=switchboard.pytest_plugin'
        ]
    },
    cmdclass={"build_ext": build_ext},
    zip_safe=False,
)