SeleniumBase/setup.py

"""Setup steps for installing SeleniumBase dependencies and plugins.
(Uses selenium 4.x and is compatible with Python 3.6+)"""
from setuptools import setup, find_packages  # noqa: F401
import os
import sys


this_dir = os.path.abspath(os.path.dirname(__file__))
long_description = None
total_description = None
try:
    with open(os.path.join(this_dir, "README.md"), "rb") as f:
        total_description = f.read().decode("utf-8")
    description_lines = total_description.split("\n")
    long_description_lines = []
    for line in description_lines:
        if not line.startswith("<meta ") and not line.startswith("<link "):
            long_description_lines.append(line)
    long_description = "\n".join(long_description_lines)
except IOError:
    long_description = "A complete library for building end-to-end tests."
about = {}
# Get the package version from the seleniumbase/__version__.py file
with open(os.path.join(this_dir, "seleniumbase", "__version__.py"), "rb") as f:
    exec(f.read().decode("utf-8"), about)

if sys.argv[-1] == "publish":
    reply = None
    input_method = input
    confirm_text = ">>> Confirm release PUBLISH to PyPI? (yes/no): "
    reply = str(input_method(confirm_text)).lower().strip()
    if reply == "yes":
        print("\n*** Checking code health with flake8:\n")
        if sys.version_info >= (3, 9):
            os.system("python -m pip install 'flake8==6.0.0'")
        else:
            os.system("python -m pip install 'flake8==5.0.4'")
        flake8_status = os.system("flake8 --exclude=recordings,temp")
        if flake8_status != 0:
            print("\nWARNING! Fix flake8 issues before publishing to PyPI!\n")
            sys.exit()
        else:
            print("*** No flake8 issues detected. Continuing...")
        print("\n*** Removing existing distribution packages: ***\n")
        os.system("rm -f dist/*.egg; rm -f dist/*.tar.gz; rm -f dist/*.whl")
        os.system("rm -rf build/bdist.*; rm -rf build/lib")
        print("\n*** Installing build: *** (Required for PyPI uploads)\n")
        os.system("python -m pip install --upgrade 'build>=0.10.0'")
        print("\n*** Installing pkginfo: *** (Required for PyPI uploads)\n")
        os.system("python -m pip install --upgrade 'pkginfo>=1.9.6'")
        print("\n*** Installing twine: *** (Required for PyPI uploads)\n")
        os.system("python -m pip install --upgrade 'twine>=4.0.2'")
        print("\n*** Installing tqdm: *** (Required for PyPI uploads)\n")
        os.system("python -m pip install --upgrade tqdm")
        print("\n*** Rebuilding distribution packages: ***\n")
        os.system("python -m build")  # Create new tar/wheel
        print("\n*** Publishing The Release to PyPI: ***\n")
        os.system("python -m twine upload dist/*")  # Requires ~/.pypirc Keys
        print("\n*** The Release was PUBLISHED SUCCESSFULLY to PyPI! :) ***\n")
    else:
        print("\n>>> The Release was NOT PUBLISHED to PyPI! <<<\n")
    sys.exit()

setup(
    name="seleniumbase",
    version=about["__version__"],
    description="A complete web automation framework for end-to-end testing.",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/seleniumbase/SeleniumBase",
    project_urls={
        "Changelog": "https://github.com/seleniumbase/SeleniumBase/releases",
        "Download": "https://pypi.org/project/seleniumbase/#files",
        "Gitter": "https://gitter.im/seleniumbase/SeleniumBase",
        "Blog": "https://seleniumbase.com/",
        "PyPI": "https://pypi.org/project/seleniumbase/",
        "Source": "https://github.com/seleniumbase/SeleniumBase",
        "Documentation": "https://seleniumbase.io/",
    },
    platforms=["Windows", "Linux", "Mac OS-X"],
    author="Michael Mintz",
    author_email="mdmintz@gmail.com",
    maintainer="Michael Mintz",
    license="MIT",
    keywords="pytest automation selenium browser testing webdriver sbase",
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        "Environment :: Console",
        "Environment :: MacOS X",
        "Environment :: Win32 (MS Windows)",
        "Environment :: Web Environment",
        "Framework :: Pytest",
        "Intended Audience :: Developers",
        "Intended Audience :: Information Technology",
        "License :: OSI Approved :: MIT License",
        "Operating System :: MacOS :: MacOS X",
        "Operating System :: Microsoft :: Windows",
        "Operating System :: POSIX :: Linux",
        "Programming Language :: Python",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: 3.12",
        "Topic :: Internet",
        "Topic :: Internet :: WWW/HTTP :: Browsers",
        "Topic :: Scientific/Engineering",
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
        "Topic :: Scientific/Engineering :: Image Processing",
        "Topic :: Scientific/Engineering :: Visualization",
        "Topic :: Software Development",
        "Topic :: Software Development :: Quality Assurance",
        "Topic :: Software Development :: Code Generators",
        "Topic :: Software Development :: Libraries",
        "Topic :: Software Development :: Testing",
        "Topic :: Software Development :: Testing :: Acceptance",
        "Topic :: Software Development :: Testing :: Traffic Generation",
        "Topic :: Utilities",
    ],
    python_requires=">=3.6",
    install_requires=[
        'pip>=21.3.1;python_version<"3.7"',
        'pip>=23.1.2;python_version>="3.7"',
        'packaging>=21.3;python_version<"3.7"',
        'packaging>=23.1;python_version>="3.7"',
        'setuptools>=59.6.0;python_version<"3.7"',
        'setuptools>=67.7.2;python_version>="3.7"',
        'keyring>=23.4.1;python_version<"3.8"',
        'keyring>=23.13.1;python_version>="3.8"',
        'tomli>=1.2.3;python_version<"3.7"',
        'tomli>=2.0.1;python_version>="3.7"',
        'tqdm>=4.64.1;python_version<"3.7"',
        'tqdm>=4.65.0;python_version>="3.7"',
        'wheel>=0.37.1;python_version<"3.7"',
        'wheel>=0.40.0;python_version>="3.7"',
        'attrs==22.1.0;python_version<"3.7"',
        'attrs>=23.1.0;python_version>="3.7"',
        "PyYAML>=6.0",
        "certifi>=2022.12.7",
        'filelock>=3.4.1;python_version<"3.7"',
        'filelock>=3.12.0;python_version>="3.7"',
        'platformdirs>=2.4.0;python_version<"3.7"',
        'platformdirs>=3.5.0;python_version>="3.7"',
        'pyparsing>=3.0.7;python_version<"3.7"',
        'pyparsing>=3.0.9;python_version>="3.7"',
        'zipp==3.6.0;python_version<"3.7"',
        'zipp>=3.15.0;python_version>="3.7"',
        'more-itertools==8.14.0;python_version<"3.7"',
        'more-itertools>=9.1.0;python_version>="3.7"',
        "six==1.16.0",
        "idna==3.4",
        'chardet==4.0.0;python_version<"3.7"',
        'chardet==5.1.0;python_version>="3.7"',
        'charset-normalizer==2.0.12;python_version<"3.7"',
        'charset-normalizer==3.1.0;python_version>="3.7"',
        'urllib3==1.26.12;python_version<"3.7"',
        'urllib3==1.26.15;python_version>="3.7"',
        'requests==2.27.1;python_version<"3.7"',
        'requests==2.29.0;python_version>="3.7"',
        'requests-toolbelt==1.0.0',
        "pynose==1.4.3",
        'sniffio==1.3.0;python_version>="3.7"',
        'h11==0.14.0;python_version>="3.7"',
        'outcome==1.2.0;python_version>="3.7"',
        'trio==0.22.0;python_version>="3.7"',
        'trio-websocket==0.10.2;python_version>="3.7"',
        'pyopenssl==23.1.1;python_version>="3.7"',
        'wsproto==1.2.0;python_version>="3.7"',
        'selenium==3.141.0;python_version<"3.7"',
        'selenium==4.9.0;python_version>="3.7"',
        'msedge-selenium-tools==3.141.3;python_version<"3.7"',
        'cssselect==1.1.0;python_version<"3.7"',
        'cssselect==1.2.0;python_version>="3.7"',
        "sortedcontainers==2.4.0",
        'fasteners==0.17.3;python_version<"3.7"',
        'fasteners==0.18;python_version>="3.7"',
        "execnet==1.9.0",
        'iniconfig==1.1.1;python_version<"3.7"',
        'iniconfig==2.0.0;python_version>="3.7"',
        "pluggy==1.0.0",
        "py==1.11.0",
        'pytest==7.0.1;python_version<"3.7"',
        'pytest==7.3.1;python_version>="3.7"',
        'pytest-forked==1.4.0;python_version<"3.7"',
        'pytest-forked==1.6.0;python_version>="3.7"',
        "pytest-html==2.0.1",  # Newer ones had issues
        'pytest-metadata==1.11.0;python_version<"3.7"',
        'pytest-metadata==2.0.4;python_version>="3.7"',
        "pytest-ordering==0.6",
        'pytest-rerunfailures==10.3;python_version<"3.7"',
        'pytest-rerunfailures==11.1.2;python_version>="3.7"',
        'pytest-xdist==2.5.0;python_version<"3.7"',
        'pytest-xdist==3.2.1;python_version>="3.7"',
        'parameterized==0.8.1;python_version<"3.7"',
        'parameterized==0.9.0;python_version>="3.7"',
        "sbvirtualdisplay==1.2.0",
        "behave==1.2.6",
        'soupsieve==2.3.2.post1;python_version<"3.7"',
        'soupsieve==2.4.1;python_version>="3.7"',
        "beautifulsoup4==4.12.2",
        'cryptography==36.0.2;python_version<"3.7"',
        'cryptography==40.0.2;python_version>="3.7"',
        'pygments==2.14.0;python_version<"3.7"',
        'pygments==2.15.1;python_version>="3.7"',
        'pyreadline3==3.4.1;platform_system=="Windows"',
        "tabcompleter==1.2.0",
        "pdbp==1.4.0",
        'colorama==0.4.5;python_version<"3.7"',
        'colorama==0.4.6;python_version>="3.7"',
        'exceptiongroup==1.1.1;python_version>="3.7"',
        'future-breakpoint==2.0.0;python_version<"3.7"',
        'importlib-metadata==4.2.0;python_version<"3.8"',
        "pycparser==2.21",
        'pyotp==2.7.0;python_version<"3.7"',
        'pyotp==2.8.0;python_version>="3.7"',
        "cffi==1.15.1",
        'typing-extensions==4.1.1;python_version<"3.7"',
        'typing-extensions==4.5.0;python_version>="3.7" and python_version<"3.9"',  # noqa: E501
        'commonmark==0.9.1;python_version<"3.7"',  # For old "rich"
        'markdown-it-py==2.2.0;python_version>="3.7"',  # For new "rich"
        'mdurl==0.1.2;python_version>="3.7"',  # For new "rich"
        'rich==12.6.0;python_version<"3.7"',
        'rich==13.3.5;python_version>="3.7"',
    ],
    extras_require={
        # pip install -e .[allure]
        # Usage: pytest --alluredir=allure_results
        # Serve: allure serve allure_results
        "allure": [
            'allure-pytest==2.9.45;python_version<"3.7"',
            'allure-pytest==2.13.2;python_version>="3.7"',
            'allure-python-commons==2.9.45;python_version<"3.7"',
            'allure-python-commons==2.13.2;python_version>="3.7"',
            'allure-behave==2.9.45;python_version<"3.7"',
            'allure-behave==2.13.2;python_version>="3.7"',
        ],
        # pip install -e .[coverage]
        # Usage: coverage run -m pytest; coverage html; coverage report
        "coverage": [
            'coverage==6.2;python_version<"3.7"',
            'coverage==7.2.5;python_version>="3.7"',
            "pytest-cov==4.0.0",
        ],
        # pip install -e .[flake8]
        # Usage: flake8
        "flake8": [
            'flake8==5.0.4;python_version<"3.9"',
            'flake8==6.0.0;python_version>="3.9"',
            "mccabe==0.7.0",
            'pyflakes==2.5.0;python_version<"3.9"',
            'pyflakes==3.0.1;python_version>="3.9"',
            'pycodestyle==2.9.1;python_version<"3.9"',
            'pycodestyle==2.10.0;python_version>="3.9"',
        ],
        # pip install -e .[ipdb]
        # (Not needed for debugging anymore. SeleniumBase now includes "pdbp".)
        "ipdb": [
            "ipdb==0.13.11",
            'ipython==7.16.3;python_version<"3.7"',
            'ipython==7.34.0;python_version>="3.7"',
        ],
        # pip install -e .[pdfminer]
        "pdfminer": [
            'pdfminer.six==20211012;python_version<"3.7"',
            'pdfminer.six==20221105;python_version>="3.7"',
        ],
        # pip install -e .[pillow]
        "pillow": [
            'Pillow==8.4.0;python_version<"3.7"',
            'Pillow==9.5.0;python_version>="3.7"',
        ],
        # pip install -e .[psutil]
        "psutil": [
            "psutil==5.9.4",
        ],
        # pip install -e .[selenium-wire]
        "selenium-wire": [
            'selenium-wire==5.1.0;python_version>="3.7"',
            'Brotli==1.0.9;python_version>="3.7"',
            'blinker==1.5;python_version>="3.7"',
            'h2==4.1.0;python_version>="3.7"',
            'hpack==4.0.0;python_version>="3.7"',
            'hyperframe==6.0.1;python_version>="3.7"',
            'kaitaistruct==0.10;python_version>="3.7"',
            'pyasn1==0.4.8;python_version>="3.7"',
            'zstandard==0.19.0;python_version>="3.7"',
        ],
    },
    packages=[
        "seleniumbase",
        "sbase",
        "seleniumbase.behave",
        "seleniumbase.common",
        "seleniumbase.config",
        "seleniumbase.console_scripts",
        "seleniumbase.core",
        "seleniumbase.drivers",
        "seleniumbase.extensions",
        "seleniumbase.fixtures",
        "seleniumbase.js_code",
        "seleniumbase.masterqa",
        "seleniumbase.plugins",
        "seleniumbase.resources",
        "seleniumbase.translate",
        "seleniumbase.undetected",
        "seleniumbase.utilities",
        "seleniumbase.utilities.selenium_grid",
        "seleniumbase.utilities.selenium_ide",
    ],
    include_package_data=True,
    entry_points={
        "console_scripts": [
            "seleniumbase = seleniumbase.console_scripts.run:main",
            "sbase = seleniumbase.console_scripts.run:main",  # Simplified name
        ],
        "nose.plugins": [
            "base_plugin = seleniumbase.plugins.base_plugin:Base",
            "selenium = seleniumbase.plugins.selenium_plugin:SeleniumBrowser",
            "page_source = seleniumbase.plugins.page_source:PageSource",
            "screen_shots = seleniumbase.plugins.screen_shots:ScreenShots",
            "test_info = seleniumbase.plugins.basic_test_info:BasicTestInfo",
            (
                "db_reporting = "
                "seleniumbase.plugins.db_reporting_plugin:DBReporting"
            ),
            "s3_logging = seleniumbase.plugins.s3_logging_plugin:S3Logging",
        ],
        "pytest11": ["seleniumbase = seleniumbase.plugins.pytest_plugin"],
    },
)

# print(os.system("cat seleniumbase.egg-info/PKG-INFO"))
print("\n*** SeleniumBase Installation Complete! ***\n")