setup.py

#   Copyright 2018 The Batfish Open Source Project
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
"""A setuptools based setup module.

See:
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject
"""

from __future__ import absolute_import, print_function

# To use a consistent encoding
from codecs import open
from os import path

# Always prefer setuptools over distutils
from setuptools import find_packages, setup

import pybatfish

here = path.abspath(path.dirname(__file__))

# Capirca dependencies
CAPIRCA_DEPS = ["capirca", "absl-py>=0.8.0"]

# Get the long description from the README file
with open(path.join(here, "README.md"), encoding="utf-8") as f:
    long_description = f.read()

setup(
    name=pybatfish.__name__,
    # Versions should comply with PEP440.  For a discussion on single-sourcing
    # the version across setup.py and the project code, see
    # https://packaging.python.org/en/latest/single_source_version.html
    version=pybatfish.__version__,
    description=pybatfish.__desc__,
    # Set description for PyPI project page
    long_description=long_description,
    long_description_content_type="text/markdown",
    # The project's main homepage.
    url=pybatfish.__url__,
    # Author details
    author="The Batfish Open Source Project",
    author_email="pybatfish-dev@intentionet.com",
    # Choose your license
    license="Apache License 2.0",
    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
    classifiers=[
        # How mature is this project? Common values are
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        "Development Status :: 3 - Alpha",
        # Indicate who your project is intended for
        "Intended Audience :: Developers",
        "Topic :: Software Development :: Libraries :: Python Modules",
        # Pick your license as you wish (should match "license" above)
        "License :: OSI Approved :: Apache Software License",
        # 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 :: Only",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: 3.12",
        "Programming Language :: Python :: 3.13",
    ],
    python_requires=">=3.9",
    # What does your project relate to?
    keywords="network configuration verification",
    # You can just specify the packages manually here if your project is
    # simple. Or you can use find_packages().
    packages=find_packages(exclude=["contrib", "docs", "tests"]),
    # Alternatively, if you want to distribute just a my_module.py, uncomment
    # this:
    #   py_modules=["my_module"],
    # List run-time dependencies here.  These will be installed by pip when
    # your project is installed. For an analysis of "install_requires" vs pip's
    # requirements files see:
    # https://packaging.python.org/en/latest/requirements.html
    install_requires=[
        "attrs>=18.1.0",
        "deepdiff",
        "pandas",
        "python-dateutil",
        "PyYAML",
        "requests",
        "requests-toolbelt",
        "simplejson",
        "urllib3>=1.26.0",
    ],
    # List additional groups of dependencies here (e.g. Capirca
    # dependencies). For example:
    # $ pip install -e .[capirca]
    extras_require={
        "capirca": CAPIRCA_DEPS,
        "dev": [
            "black<23.11",
            "cerberus",
            "check-manifest",
            "coverage",
            "inflection",
            "jupyter",
            "mypy<=1.6",
            "nbconvert",
            "nbsphinx",
            "progressbar2",
            "pytest>=4.2.0",
            "pytest-cov",
            "pytz",
            "recommonmark",
            "requests_mock",
            "responses",
            "sphinx>=1.8.0",
            "sphinx-notfound-page",
            "sphinx_rtd_theme",
            "types-decorator",
            "types-python-dateutil",
            "types-pytz",
            "types-PyYAML",
            "types-requests",
            "types-setuptools",
            "types-simplejson",
        ]
        + CAPIRCA_DEPS,
    },
    # List pytest requirements for running unit tests
    setup_requires=["pytest-runner"],
    # If there are data files included in your packages that need to be
    # installed, specify them here.  If using Python 2.6 or less, then these
    # have to be included in MANIFEST.in as well.
    package_data={
        # Indicate Pybatfish supports type hinting
        # https://www.python.org/dev/peps/pep-0561/
        "pybatfish": ["py.typed"]
    },
    # Although 'package_data' is the preferred approach, in some case you may
    # need to place data files outside of your packages. See:
    # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa
    # In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
    data_files=[],
    # To provide executable scripts, use entry points in preference to the
    # "scripts" keyword. Entry points provide cross-platform support and allow
    # pip to create the appropriate form of executable for the target platform.
    entry_points={"batfish_session": ["bf = pybatfish.client.session:Session"]},
    # Required for mypy to find Pybatfish (see https://mypy.readthedocs.io/en/latest/installed_packages.html#making-pep-561-compatible-packages)
    zip_safe=False,
)