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

sdv_installer/utils/system_requirements.py

@@ -0,0 +1,173 @@
+"""System requirements utility functions."""
+
+import platform
+import re
+import subprocess
+import sys
+import sysconfig
+
+import pip
+from packaging.tags import sys_tags
+from packaging.version import Version
+
+from sdv_installer.constants import (
+    MAX_PYTHON_VERSION,
+    MIN_PYTHON_VERSION,
+    REQUIRED_BITNESS,
+)
+from sdv_installer.utils.console_utils import print_message
+
+
+def get_os_info():
+    """Detects the operating system type and version.
+
+    Returns:
+        Tuple[str, str, Optional[str], bool]: A tuple containing:
+            - os_system (str): 'macOS', 'Linux', or other OS name.
+            - os_version (str): The major OS version (e.g., '14').
+            - linux_distro (Optional[str]): Pretty name of the Linux distribution, if applicable.
+            - is_linux (bool): Whether the OS is Linux.
+    """
+    system = platform.system()
+    version = platform.version()
+    is_linux = sys.platform == 'linux'
+    linux_distro = None
+
+    if sys.platform == 'darwin':
+        version = subprocess.check_output(['sw_vers', '-productVersion'], text=True).strip()
+        system = 'macOS'
+
+    elif is_linux:
+        version = platform.release()
+        output = subprocess.run('cat /etc/*-release', shell=True, capture_output=True, text=True)
+        match = re.search(r"PRETTY_NAME='(.*)'", output.stdout.strip())
+        linux_distro = match.group(1) if match else None
+
+    return system, version.split('.')[0], linux_distro, is_linux
+
+
+def get_architecture():
+    """Determines the system architecture (e.g., arm64, x86_64).
+
+    Returns:
+        str: The system's architecture identifier.
+    """
+    if platform.system().lower() == 'windows':
+        return sysconfig.get_platform()
+
+    return subprocess.check_output(['uname', '-m'], text=True).strip().lower()
+
+
+def get_current_platform_tag():
+    """Returns the normalized platform tag for the current system."""
+    return sysconfig.get_platform().replace('-', '_').replace('.', '_')
+
+
+def get_python_version_code():
+    """Returns the current Python major and minor version as a tuple."""
+    major = sys.version_info.major
+    minor = sys.version_info.minor
+    return Version(f'{major}.{minor}')
+
+
+def get_system_info():
+    """Collects all relevant system information for SDV Installer validation.
+
+    Returns:
+        dict: A dictionary with system attributes including:
+            - os_system (str)
+            - os_version (str)
+            - linux_distro (Optional[str])
+            - architecture (str)
+            - python_version (str)
+            - system_bit (str)
+            - pip_version (str)
+            - platform_tag (str)
+            - processor (str)
+            - is_linux (bool)
+    """
+    os_system, os_version, linux_distro, is_linux = get_os_info()
+    arch = get_architecture()
+    python_version = platform.python_version()
+    bitness = '64-bit' if sys.maxsize > 2**32 else '32-bit'
+    pip_version = pip.__version__
+    processor = platform.processor()
+    platform_tag = get_current_platform_tag()
+
+    return {
+        'os_system': os_system,
+        'os_version': os_version,
+        'linux_distro': linux_distro,
+        'architecture': arch,
+        'python_version': python_version,
+        'system_bit': bitness,
+        'pip_version': pip_version,
+        'platform_tag': platform_tag,
+        'processor': processor,
+        'is_linux': is_linux,
+    }
+
+
+def get_user_supported_tags():
+    """Retrieves the set of platform tags supported by the current Python environment.
+
+    These tags are used to determine compatibility with precompiled wheels.
+
+    Returns:
+        Set[str]:
+            A set of supported platform tag strings.
+    """
+    return {tag.platform for tag in sys_tags()}
+
+
+def validate_system_requirements(info):
+    """Validates the current system against the minimum technical requirements.
+
+    Args:
+        info (dict): A dictionary containing system info (as from `get_system_info`).
+
+    Returns:
+        List[str]: A list of keys that failed validation (e.g., ['python_version']).
+    """
+    errors = []
+    python_version = get_python_version_code()
+    if python_version < MIN_PYTHON_VERSION or python_version > MAX_PYTHON_VERSION:
+        errors.append('python_version')
+
+    if info['system_bit'] != REQUIRED_BITNESS:
+        errors.append('system_bit')
+
+    return errors
+
+
+def print_check_results():
+    """Runs the system checks and prints the result in a user-friendly format."""
+    print_message('Verifying system requirements for SDV Enterprise: \n')
+    info = get_system_info()
+    errors = validate_system_requirements(info)
+
+    def mark(key):
+        return ' (!)' if key in errors else ''
+
+    print_message(f'Operating system: {info["os_system"]}')
+    print_message(f'OS Version: {info["os_version"]}')
+    if info['is_linux'] and info['linux_distro']:
+        print_message(f'Linux Distribution: {info["linux_distro"]}')
+
+    print_message(f'Architecture: {info["architecture"]}')
+    print_message(f'Python Version: {info["python_version"]}{mark("python_version")}')
+    print_message(f'System bit: {info["system_bit"]}{mark("system_bit")}')
+    print_message(f'Pip version: {info["pip_version"]}')
+
+    print_message(f'\nResult: {"Passed" if not errors else "Failed"}')
+    if not errors:
+        print_message('Your system meets the technical requirements for SDV Enterprise.')
+        sys.exit(0)
+    else:
+        print_message(
+            'Your system may not meet the technical requirements for SDV Enterprise. '
+            'Please check the items marked by (!) and try updating the SDV '
+            "Installer if something doesn't seem right."
+        )
+        print_message('The most up-to-date requirements are on the SDV Enterprise docs site.')
+        sys.exit(1)

sdv_installer-0.0.0.dev11.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: sdv-installer
+Version: 0.0.0.dev11
+Summary: Package to install SDV Enterprise packages.
+Author-email: "DataCebo, Inc." <info@datacebo.com>
+License: MIT
+Keywords: sdv,synthetic-data,synthetic-data-generation,timeseries,single-table,multi-table
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: License :: Free for non-commercial use
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: <3.14,>=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: platformdirs
+Requires-Dist: pip
+Requires-Dist: packaging
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: invoke; extra == "test"
+Requires-Dist: packaging; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pip>=9.0.1; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: invoke; extra == "dev"
+Requires-Dist: bump-my-version>=0.18.3; extra == "dev"
+Requires-Dist: ruff>=0.7.1; extra == "dev"
+Requires-Dist: twine<4,>=1.10.0; extra == "dev"
+Requires-Dist: wheel>=0.30.0; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: tomli; extra == "dev"
+Dynamic: license-file
+
+_This package is part of [The Synthetic Data Vault Project](https://sdv.dev/),
+a project from [DataCebo](https://datacebo.com/)._
+
+# Overview
+
+The [**Synthetic Data Vault**](https://docs.sdv.dev/sdv) (SDV) is a Python
+library designed to be your one-stop shop for creating tabular synthetic data.
+You can get started with the publicly-available SDV Community for exploring the
+benefits of synthetic data. When you're ready to take synthetic data to the
+next level, upgrade to [SDV Enterprise](https://docs.sdv.dev/sdv/explore/sdv-enterprise)
+and purchase [Bundles](https://docs.sdv.dev/sdv/explore/sdv-bundles) to access additional features.
+
+This package provides a CLI for SDV Enterprise customers to easily access and
+manage all SDV-related software. It allows you to:
+
+* Input your SDV username and license key
+* List out all the SDV-related packages that you have access to
+* Download and install those packages
+
+```
+% sdv-installer install
+
+Username: <email>
+License Key: ********************************
+
+Installing SDV Enterprise:
+sdv-enterprise (version 0.30.0) - Installed!
+
+Installing Bundles:
+bundle-cag - Installed!
+bundle-xsynthesizers - Installed!
+
+Success! All packages have been installed. You are ready to use SDV Enterprise.
+```
+
+# How it works
+
+The SDV Installer is a convenience wrapper around
+[pip](https://pypi.org/project/pip/), the package installer for Python.
+Under-the-hood, SDV Installer takes your input, determines which
+package you can access, and calls pip to install those packages with the
+appropriate flags and options.
+
+To see the exact pip commands, use the `--debug` flag:
+
+```
+% sdv-installer install --debug
+
+Username: <email>
+License Key: ********************************
+
+Installing SDV Enterprise:
+
+pip install sdv-enterprise==0.30.0 --index-url <URL>@pypi.datacebo.com/ --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.datacebo.com
+
+Installing Bundles:
+...
+
+Success! All packages have been installed. You are ready to use SDV Enterprise.
+```
+
+# Get the SDV Installer
+
+Get the latest version of the SDV Installer.
+
+```
+pip install sdv-installer --update
+```
+
+SDV Installer is set up to access and manage all SDV-related packages – SDV
+Enterprise, as well as Bundles. You can manage installation for a variety of
+scenarios, including offline installation, partial installation, upgrading, and
+more.
+
+
+**For more details about installing SDV Enterprise, please see our
+[Installation
+Guide](https://docs.sdv.dev/sdv-enterprise/installation/instructions).**

sdv_installer-0.0.0.dev11.dist-info/RECORD

@@ -0,0 +1,21 @@
+sdv_installer/__init__.py,sha256=RXeNlhAjGFz_gGk863kczpcHlW6cT51e0hxKRNahmdo,142
+sdv_installer/config.py,sha256=SvS980hLC9nVDHNF7-B-yeVbylvYCELYEL131mXWzgs,534
+sdv_installer/constants.py,sha256=6Br9LZhun3q779UI64kBiEdYKs4Ene-n0H18lQ-T2-Q,3241
+sdv_installer/authentication/__init__.py,sha256=-iqEkKCShkX8sfR31olJQwgdgPNP9xcoHFdGc_YI6tQ,212
+sdv_installer/authentication/authentication.py,sha256=5p_SOUN_SfEiyH7Jp7iy6DTBgulC7mpeXYpkp2Q3lCg,2255
+sdv_installer/cli/__init__.py,sha256=JMCw-iO9uuWICi6BI8nHcMhJ4quXye32FE_BX2eKlfQ,44
+sdv_installer/cli/__main__.py,sha256=vGeXYvceBg1BMkHenoqdYjaeS-4nyFVEsEoku9KJgzU,4927
+sdv_installer/installation/__init__.py,sha256=5Uf1aAq89-END8vbHtZV3rcfN7wWfp887EKAw-t-t1U,350
+sdv_installer/installation/installer.py,sha256=yIGWXmGsNlRiQ1u4Abm1hkYq7Q7q-RFpp9OuJQNwWtg,16289
+sdv_installer/utils/__init__.py,sha256=NLBXxSvHn2rEoyo6CxuM-CFAyPSBwnb2oocwQGBES1A,1572
+sdv_installer/utils/console_utils.py,sha256=seNY-tntEZ5HUhiehsHetgVdcf-rSTGaduK2sbRR71c,9202
+sdv_installer/utils/data_storage.py,sha256=aVWwqwQQ9WpFKgJyMKTc-9vDG3Bly-amvFDWv0kjoMM,2619
+sdv_installer/utils/package_utils.py,sha256=qydAmKCndXOuUODvZsC3YI_7wpoWtFIsZmtJvXZOKkk,9034
+sdv_installer/utils/request_error_handling.py,sha256=C5hFXL8r8HbBWAZB0NzGc1owWyjc84QXvrrDN9Jv4os,1975
+sdv_installer/utils/system_requirements.py,sha256=SVCNodGfQRfvlVPqt-prjq1l53cVX7w_WWXC856dFFY,5750
+sdv_installer-0.0.0.dev11.dist-info/licenses/LICENSE,sha256=yvPXLYJjZGdrkpah9WFuFg_V6kdZuwgyGkDLrJMMTV0,1065
+sdv_installer-0.0.0.dev11.dist-info/METADATA,sha256=bAZmeyk6lfBepc8asMZu_qNM57suwm-pZSO7G9jWrwY,4197
+sdv_installer-0.0.0.dev11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sdv_installer-0.0.0.dev11.dist-info/entry_points.txt,sha256=ozVfQCFQrrd5TZgfBk_wbUBpM_WkKDJCLpEHS6BAIDU,69
+sdv_installer-0.0.0.dev11.dist-info/top_level.txt,sha256=JZIG54yO4VvC8VDszSiKdCyBZyxos0BUkFADrBBYWXI,14
+sdv_installer-0.0.0.dev11.dist-info/RECORD,,

sdv_installer-0.0.0.dev11.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sdv_installer-0.0.0.dev11.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sdv-installer = sdv_installer.cli.__main__:run_cli

sdv_installer-0.0.0.dev11.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 DataCebo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sdv_installer-0.0.0.dev11.dist-info/top_level.txt

@@ -0,0 +1 @@
+sdv_installer