sdv-installer 0.0.0.dev11__py3-none-any.whl

sdv_installer/__init__.py

@@ -0,0 +1,7 @@
+"""SDV-Installer main module."""
+
+from sdv_installer import config, constants
+
+
+__all__ = ('config', 'constants')
+__version__ = '0.0.0.dev11'

sdv_installer/authentication/__init__.py

@@ -0,0 +1,8 @@
+"""Authentication module."""
+
+from sdv_installer.authentication.authentication import (
+    authenticate,
+    authenticate_user_and_license_key,
+)
+
+__all__ = ('authenticate', 'authenticate_user_and_license_key')

sdv_installer/authentication/authentication.py

@@ -0,0 +1,74 @@
+"""Licensing authentication module."""
+
+from functools import wraps
+
+import requests
+from requests.exceptions import RequestException
+
+from sdv_installer import config
+from sdv_installer.utils import (
+    get_password_input,
+    print_failed_to_connect,
+    print_invalid_credentials,
+)
+
+
+def authenticate_user_and_license_key(username, license_key):
+    """Authenticate the user and license key by sending a request to the authentication API.
+
+    Constructs an authentication request using the provided username and license key,
+    sends it to the appropriate API endpoint, and returns a boolean indicating whether
+    the authentication was successful.
+
+    Args:
+        username (str):
+            The username to authenticate.
+        license_key (str):
+            The license key to authenticate.
+
+    Raises:
+        InvalidLoginCredentials:
+            If the user has provided invalid login credentials.
+
+    Returns:
+        bool:
+            True if authentication is successful, False otherwise.
+    """
+    post_data = {'username': username, 'license_key': license_key}
+    try:
+        response = requests.post(
+            config.API_VALIDATE, json=post_data, headers=config.HEADERS, timeout=config.TIMEOUT
+        )
+    except RequestException:
+        print_failed_to_connect()
+        return False
+
+    response_dict = response.json()
+    valid = response_dict.get('valid', False)
+    authenticated = bool(response.status_code == requests.codes.ok and valid)
+    if not authenticated:
+        print_invalid_credentials()
+
+    return authenticated
+
+
+def authenticate(function):
+    """Authenticate wrapper to be used by other functions."""
+
+    @wraps(function)
+    def wrapper(*args, **kwargs):
+        if kwargs.get('username') and kwargs.get('license_key'):
+            username = kwargs['username']
+            license_key = kwargs['license_key']
+
+        else:
+            username = input('Username: ')
+            license_key = get_password_input('License Key: ')
+            kwargs['username'] = username
+            kwargs['license_key'] = license_key
+
+        authenticated = authenticate_user_and_license_key(username, license_key)
+        if authenticated:
+            return function(*args, **kwargs)
+
+    return wrapper

sdv_installer/cli/__init__.py

@@ -0,0 +1 @@
+"""SDV-Installer command line interface."""

sdv_installer/cli/__main__.py

@@ -0,0 +1,165 @@
+"""SDV-Installer command line interface."""
+
+import argparse
+import sys
+
+from sdv_installer.installation import (
+    download_packages,
+    install_packages,
+    install_packages_from_folder,
+    list_packages,
+    uninstall_packages,
+)
+from sdv_installer.utils.system_requirements import print_check_results
+
+
+def install_action(args):
+    """Install the `SDV-Enterprise` packages."""
+    if args.folder:
+        install_packages_from_folder(
+            folder=args.folder,
+            package=args.package,
+            options=args.options,
+            debug=args.debug,
+        )
+
+    else:
+        install_packages(
+            package=args.package,
+            options=args.options,
+            debug=args.debug,
+            version=args.version,
+            upgrade=args.upgrade,
+        )
+
+
+def uninstall_action(args):
+    """Uninstall the `SDV-Enterprise` packages."""
+    uninstall_packages(debug=args.debug)
+
+
+def download_action(args):
+    """Download SDV-Enterprise packages for offline install."""
+    download_packages(
+        package=args.package,
+        python_version=args.python_version,
+        platform=args.platform,
+        folder=args.folder,
+        version=args.version,
+        options=args.options,
+        debug=args.debug,
+    )
+
+
+def list_action(args, parser=None):
+    """List all packages the user has access to."""
+    list_packages()
+
+
+def perform_check_action(args):
+    """Perform a check on the user's system to verify compatibility with SDV-Enterprise."""
+    print_check_results()
+
+
+def get_parser():
+    """Return the argparser for the SDV-Installer application."""
+    parser = argparse.ArgumentParser(description='SDV Installer.')
+    parser.set_defaults(action=None)
+
+    action = parser.add_subparsers(title='action')
+
+    # Install
+    install_parser = action.add_parser('install', help='Install your SDV Enterprise Packages.')
+    install_parser.set_defaults(action=install_action)
+    install_parser.add_argument(
+        '--package',
+        required=False,
+        help='The package that you want to install.',
+    )
+    install_parser.add_argument(
+        '--options', help='Optional dependencies to install.', required=False, nargs='+'
+    )
+    install_parser.add_argument('--folder', type=str, help='Install from a local folder.')
+    install_parser.add_argument('--debug', action='store_true', help='Print pip install commands.')
+    install_parser.add_argument(
+        '-v', '--version', required=False, help='SDV-Enterprise version (e.g., 0.23.0).'
+    )
+    install_parser.add_argument(
+        '-u',
+        '--upgrade',
+        required=False,
+        help='Upgrade the current installed packages.',
+        action='store_true',
+    )
+
+    # Uninstall
+    uninstall_parser = action.add_parser(
+        'uninstall', help='Uninstall your SDV Enterprise Packages.'
+    )
+    uninstall_parser.set_defaults(action=uninstall_action)
+    uninstall_parser.add_argument(
+        '--debug', action='store_true', help='Print pip install commands.'
+    )
+
+    # Download
+    download_parser = action.add_parser(
+        'download',
+        help='Download your SDV Enterprise Packages for offline installation.',
+    )
+    download_parser.set_defaults(action=download_action)
+    download_parser.add_argument(
+        '--package',
+        required=False,
+        help=(
+            'The package that you want to download. If not provided, all '
+            'packages will be downloaded',
+        ),
+    )
+    download_parser.add_argument(
+        '--python-version', required=False, help='Python version (e.g., 39).'
+    )
+    download_parser.add_argument(
+        '--platform',
+        required=False,
+        help='Platform tag(s) (e.g., macosx_14_0_arm64). You can specify this multiple times.',
+        action='append',
+    )
+    download_parser.add_argument(
+        '--folder', required=True, help='Destination folder for downloaded packages.'
+    )
+    download_parser.add_argument(
+        '--debug', action='store_true', help='Print pip download commands.'
+    )
+    download_parser.add_argument(
+        '--version', required=False, help='SDV-Enterprise version (e.g., 0.23).'
+    )
+    download_parser.add_argument(
+        '--options', help='Optional dependencies to install.', required=False, nargs='+'
+    )
+
+    # List
+    list_parser = action.add_parser('list-packages', help='List all packages you have access to.')
+    list_parser.set_defaults(action=list_action)
+
+    # Check Requirements
+    check_parser = action.add_parser(
+        'check-requirements', help='Check if your system meets SDV Enterprise requirements.'
+    )
+    check_parser.set_defaults(action=perform_check_action)
+
+    return parser
+
+
+def run_cli():
+    """Run command line interface."""
+    parser = get_parser()
+    if len(sys.argv) < 2:
+        parser.print_help()
+        sys.exit(0)
+
+    args = parser.parse_args()
+    args.action(args)
+
+
+if __name__ == '__main__':
+    run_cli()

sdv_installer/config.py

@@ -0,0 +1,19 @@
+"""Configuration module for SDV-Installer."""
+
+import os
+
+# Default API URL that will be used
+LKS_URL = os.getenv('LKS_URL', 'https://lks.datacebo.com')
+
+# Endpoints
+API_PACKAGE_PERMISSIONS = f'{LKS_URL}/api/v1/package_permissions/active'
+API_VALIDATE = f'{LKS_URL}/api/v1/licenses/validate'
+
+# Pypi Server to be used
+PYPI_URL = os.getenv('PYPI_URL', 'pypi.datacebo.com')
+
+# Headers
+HEADERS = {'accept': 'application/json', 'Content-Type': 'application/json'}
+
+# Timeout Value for API Calls
+TIMEOUT = os.getenv('SDV_API_TIMEOUT', 10)

sdv_installer/constants.py

@@ -0,0 +1,130 @@
+"""Constants used across the SDV-Installer."""
+
+from enum import IntEnum
+
+try:
+    from enum import StrEnum as StringEnum
+
+except ImportError:
+    from enum import Enum as StringEnum
+
+from packaging.version import Version
+
+from sdv_installer.config import PYPI_URL
+
+MIN_PYTHON_VERSION = Version('3.8')
+MAX_PYTHON_VERSION = Version('3.13')
+REQUIRED_BITNESS = '64-bit'
+
+SUPPORTED_PLATFORM_TAGS = [
+    'macosx_10_9_x86_64',
+    'macosx_11_0_universal2',
+    'macosx_11_0_x86_64',
+    'macosx_12_0_arm64',
+    'macosx_12_0_x86_64',
+    'macosx_13_0_arm64',
+    'macosx_13_0_x86_64',
+    'macosx_14_0_arm64',
+    'macosx_14_0_x86_64',
+    'manylinux2010_x86_64',
+    'manylinux2014_x86_64',
+    'manylinux_2_17_x86_64',
+    'manylinux_2_28_x86_64',
+    'musllinux_1_1_x86_64',
+    'win_amd64',
+]
+
+EXPECTED_PACKAGES = set([
+    'sdv-enterprise',
+    'sdv-enterprise-full',
+    'bundle-cag',
+    'bundle-ai-connectors',
+    'bundle-xsynthesizers',
+    'bundle-differential-privacy',
+])
+
+TRUSTED_HOSTS = [
+    'pypi.org',
+    'pypi.python.org',
+    'files.pythonhosted.org',
+    PYPI_URL,
+]
+
+CONNECTORS_PACKAGES = [
+    'bundle-ai-connectors',
+]
+
+
+ACTION_SUCCESS_MESSAGE = {
+    'install': 'Installed!',
+    'uninstall -y': 'Uninstalled!',
+    'download': 'Downloaded!',
+}
+
+ACTION_SUCCESS_ALREADY_INSTALLED = {
+    'install': 'N/A (already installed)',
+}
+
+ACTION_SUCCESS_ALREADY_UPDATED = {
+    'install': 'N/A (already installed and up-to-date)',
+}
+
+ACTION_ERROR_MESSAGE = {
+    'install': 'Installation failed. Use --debug for more details.',
+    'uninstall -y': 'Uninstall failed. Use --debug for more details.',
+    'download': 'Download failed. Use --debug for more details.',
+}
+ADDITIONAL_DEPS_MESSAGE_PREFIX = (
+    'Note: This package has additional required dependencies that were also installed'
+)
+
+# Constants for keypresses
+ENTER_KEY = '\r'
+BACKSPACE_KEYS = ['\x08', '\x7f']
+NEWLINE_KEY = '\n'
+
+# Constants for Summary Messages
+SUMMARY_SUCCESS_MESSAGE = {
+    'install': ('Success! All packages have been installed. You are ready to use SDV Enterprise.'),
+    'download': (
+        'Success! All packages have been downloaded. '
+        'Please install the packages to use SDV Enterprise.'
+    ),
+}
+
+SUMMARY_PARTIAL_SUCCESS_MESSAGE = {
+    'install': (
+        'Notice! All packages were installed, but `sdv-enterprise` was not included.\n'
+        'To use SDV Enterprise, please make sure it is installed.'
+    ),
+    'download': (
+        'Notice! All packages were downloaded, but `sdv-enterprise` was not included.\n'
+        'Please make sure that you have downloaded SDV-Enterprise in order to '
+        'be able to install it later.'
+    ),
+}
+
+SUMMARY_WARNING_MESSAGE = {
+    'install': (
+        'Warning! Some packages that you have access to could not be installed. '
+        'Please check your setup and contact DataCebo to troubleshoot.'
+    ),
+    'download': (
+        'Warning! Some packages that you have access to could not be downloaded. '
+        'Please check your setup and contact DataCebo to troubleshoot.'
+    ),
+}
+
+
+class ProductType(StringEnum):
+    """Product type enum."""
+
+    BASE = 'base'
+    BUNDLE = 'bundle'
+
+
+class ExitCode(IntEnum):
+    """Exit Code Representation."""
+
+    SUCCESS = 0
+    ERROR = 1

sdv_installer/installation/__init__.py

@@ -0,0 +1,17 @@
+"""Installation Module."""
+
+from sdv_installer.installation.installer import (
+    download_packages,
+    install_packages_from_folder,
+    install_packages,
+    list_packages,
+    uninstall_packages,
+)
+
+__all__ = (
+    'download_packages',
+    'install_packages',
+    'install_packages_from_folder',
+    'list_packages',
+    'uninstall_packages',
+)