setup.py

#  This file is part of RADAR.
#  Copyright (C) 2019 Cole Daubenspeck
#
#  RADAR is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  RADAR is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with RADAR.  If not, see <https://www.gnu.org/licenses/>.

import setuptools


#===============================================================================
#  Read detailed info from files where relevant to better build egg
#===============================================================================

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

with open("requirements.txt", "r", encoding="utf-8") as requirements_fh:
    required_packages = requirements_fh.read().splitlines()


#===============================================================================
#  List of executable scripts to install so they are in $PATH
#===============================================================================

scripts = [
    "scripts/radar.py",
    "scripts/radar-ctl.py",
    "scripts/radar-uplink.py",
    "scripts/radar-server.py"
]


#===============================================================================
#  Build egg below
#===============================================================================

setuptools.setup(
    name="cyber-radar",
    version="0.3.5",
    author="Cole Daubenspeck",
    author_email="coleipod@gmail.com",
    description="A framework to support a Red-team Analysis, Documentation, and Automation Revolution!",
    long_description=long_description,
    long_description_content_type="text/markdown",
    license="GPLv3",
    url="https://github.com/sevaarcen/RADAR",
    packages=setuptools.find_packages(),
    scripts=scripts,
    include_package_data=True,
    # tags and stuff for project
    classifiers=[
        "Programming Language :: Python :: 3",
        "Operating System :: OS Independent",
        "Development Status :: 4 - Beta",
    ],
    # gotta have 3.6+ for the f-strings :)
    python_requires='>=3.6',
    # other things required for this to be installed correctly
    install_requires=required_packages
)