sdv-installer 0.2.1.dev0__tar.gz → 0.3.1.dev0__tar.gz

{sdv_installer-0.2.1.dev0/sdv_installer.egg-info → sdv_installer-0.3.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdv-installer
-Version: 0.2.1.dev0
+Version: 0.3.1.dev0
 Summary: Package to install SDV Enterprise packages.
 Author-email: "DataCebo, Inc." <info@datacebo.com>
 License-Expression: MIT

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0}/pyproject.toml

@@ -165,7 +165,7 @@ max-doc-length = 100
 max-line-length = 100
 
 [tool.bumpversion]
-current_version = "0.2.1.dev0"
+current_version = "0.3.1.dev0"
 parse = '(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<candidate>\d+))?'
 serialize = [
     '{major}.{minor}.{patch}.{release}{candidate}',

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0}/sdv_installer/__init__.py

@@ -4,4 +4,4 @@ from sdv_installer import config, constants
 
 
 __all__ = ('config', 'constants')
-__version__ = '0.2.1.dev0'
+__version__ = '0.3.1.dev0'

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0}/sdv_installer/cli/__main__.py

@@ -5,6 +5,7 @@ import sys
 
 from sdv_installer.installation import (
     download_packages,
+    get_auth_file,
     install_packages,
     install_packages_from_folder,
     list_packages,
@@ -13,7 +14,7 @@ from sdv_installer.installation import (
 from sdv_installer.utils.system_requirements import print_check_results
 
 # Adding a new version here to avoid circular imports
-SDV_INSTALLER_VERSION = '0.2.1.dev0'
+SDV_INSTALLER_VERSION = '0.3.1.dev0'
 
 
 def install_action(args):
@@ -67,6 +68,16 @@ def list_action(args, parser=None):
     )
 
 
+def authenticate_action(args):
+    """Download auth file."""
+    get_auth_file(
+        username=args.username,
+        license_key=args.license_key,
+        folder=args.folder,
+        credentials=args.credentials,
+    )
+
+
 def perform_check_action(args):
     """Perform a check on the user's system to verify compatibility with SDV-Enterprise."""
     print_check_results()
@@ -130,7 +141,7 @@ def get_parser():
         required=False,
         help=(
             'The package that you want to download. If not provided, all '
-            'packages will be downloaded',
+            'packages will be downloaded'
         ),
     )
     download_parser.add_argument(
@@ -171,6 +182,18 @@ def get_parser():
         '--credentials', required=False, help='Path to a credentials json file.'
     )
 
+    # Authenticate
+    auth_parser = action.add_parser(
+        'authenticate', help='Download auth file to required destination or specified folder.'
+    )
+    auth_parser.set_defaults(action=authenticate_action)
+    auth_parser.add_argument('--username', required=False, help='SDV-Enterprise username.')
+    auth_parser.add_argument('--license-key', required=False, help='SDV-Enterprise license key.')
+    auth_parser.add_argument('--folder', required=False, help='Destination folder for auth file.')
+    auth_parser.add_argument(
+        '--credentials', required=False, help='Path to a credentials json file.'
+    )
+
     # Check Requirements
     check_parser = action.add_parser(
         'check-requirements', help='Check if your system meets SDV Enterprise requirements.'

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0}/sdv_installer/config.py

@@ -8,6 +8,7 @@ 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'
+API_AUTH_FILE = f'{LKS_URL}/api/v1/licenses/auth_file'
 
 # Pypi Server to be used
 PYPI_URL = os.getenv('PYPI_URL', 'pypi.datacebo.com')

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0}/sdv_installer/constants.py

@@ -17,6 +17,7 @@ from sdv_installer.config import PYPI_URL
 MIN_PYTHON_VERSION = Version('3.9')
 MAX_PYTHON_VERSION = Version('3.14')
 REQUIRED_BITNESS = '64-bit'
+AUTH_FILE_NAME = 'auth.json'
 
 SUPPORTED_PLATFORM_TAGS = [
     'macosx_10_9_x86_64',

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0}/sdv_installer/installation/__init__.py

@@ -2,6 +2,7 @@
 
 from sdv_installer.installation.installer import (
     download_packages,
+    get_auth_file,
     install_packages_from_folder,
     install_packages,
     list_packages,
@@ -10,6 +11,7 @@ from sdv_installer.installation.installer import (
 
 __all__ = (
     'download_packages',
+    'get_auth_file',
     'install_packages',
     'install_packages_from_folder',
     'list_packages',

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0}/sdv_installer/installation/installer.py

@@ -3,16 +3,21 @@
 import glob
 import json
 import logging
+import os
+import pathlib
+import shutil
 import subprocess
 import sys
 from typing import Dict, List, Optional, Union
 
 import requests
+from platformdirs import user_data_dir
 from requests.exceptions import RequestException
 
 from sdv_installer import config
 from sdv_installer.authentication import authenticate
 from sdv_installer.constants import (
+    AUTH_FILE_NAME,
     CONNECTORS_PACKAGES,
     EXPECTED_PACKAGES,
     TRUSTED_HOSTS,
@@ -336,6 +341,85 @@ def _get_packages(username, license_key, package=None, options=None):
     return package_to_product_type
 
 
+def _create_user_data_dir(data_dir, error_message=None):
+    if not error_message:
+        error_message = "Unable to write auth file to user's data directory. Permissions required."
+    try:
+        data_dir_path = pathlib.Path(data_dir)
+        data_dir_path.mkdir(parents=True, exist_ok=True)
+    except PermissionError:
+        raise RuntimeError(error_message)
+
+
+def _save_auth_file(username, license_key, folder=None):
+    """Retrieve the auth file for a user and save it to their appdata folder.
+
+    Args:
+        username (str):
+            Username of user to get auth file for.
+        license_key (str):
+            User's license key.
+        folder (str | None):
+            Folder to save the auth file to.
+    """
+    error_message = None
+    if folder:
+        data_dir = folder
+        error_message = 'Unable to create specified folder. Permissions required.'
+    else:
+        data_dir = user_data_dir(appname='sdv-enterprise', appauthor='Datacebo')
+
+    _create_user_data_dir(data_dir, error_message)
+    auth_file_path = pathlib.Path(data_dir, AUTH_FILE_NAME)
+    try:
+        response = requests.post(
+            config.API_AUTH_FILE,
+            data=json.dumps({'username': username, 'license_key': license_key}),
+            headers=config.HEADERS,
+        )
+        response.raise_for_status()
+    except requests.HTTPError as e:
+        raise RuntimeError('Could not fetch auth file') from e
+
+    auth_json = response.json()
+    with open(auth_file_path, 'w') as f:
+        json.dump(auth_json, f)
+
+
+def _move_auth_file(source_folder, destination=None):
+    """Move the auth file to the required location.
+
+    Args:
+        source_folder (str):
+            The folder the auth file is in.
+        destination (str | None):
+            The path to move the file to. If None, then move to the user data dir.
+    """
+    if destination is None:
+        destination = user_data_dir(appname='sdv-enterprise', appauthor='Datacebo')
+        _create_user_data_dir(destination)
+
+    auth_file_path = pathlib.Path(source_folder, AUTH_FILE_NAME)
+    if os.path.exists(auth_file_path):
+        shutil.copy(auth_file_path, pathlib.Path(destination) / AUTH_FILE_NAME)
+
+
+@authenticate
+def get_auth_file(username=None, license_key=None, folder=None, **kwargs):
+    """Retrieve the auth file from the license key service.
+
+    Args:
+        username (str):
+            The username for SDV Enterprise.
+        license_key (str):
+            The license key.
+        folder (str):
+            The folder path to save the auth file to. If None, it will save to the
+            location SDV Enterprise requires.
+    """
+    _save_auth_file(username=username, license_key=license_key, folder=folder)
+
+
 @authenticate
 def install_packages(
     username=None,
@@ -348,6 +432,7 @@ def install_packages(
     **kwargs,
 ):
     """Install packages in the current environment (online)."""
+    _save_auth_file(username, license_key)
     all_sdv_enterprise_related_pkgs = _get_accessible_packages(username, license_key)
     packages_before_install = list_current_installed_packages()
 
@@ -381,6 +466,7 @@ def install_packages(
 def install_packages_from_folder(folder, package=None, options=None, debug=False):
     """Install packages from a folder (offline)."""
     wheels = glob.glob(f'{folder}/*.whl')
+    _move_auth_file(folder)
     packages = set()
     for wheel in wheels:
         package_name = get_package_name(wheel)
@@ -468,6 +554,7 @@ def download_packages(
     **kwargs,
 ):
     """Download packages into a local folder for offline installation."""
+    _save_auth_file(username, license_key, folder=folder)
     packages = _get_packages(
         username=username, license_key=license_key, package=package, options=options
     )

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0/sdv_installer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdv-installer
-Version: 0.2.1.dev0
+Version: 0.3.1.dev0
 Summary: Package to install SDV Enterprise packages.
 Author-email: "DataCebo, Inc." <info@datacebo.com>
 License-Expression: MIT

{sdv_installer-0.2.1.dev0 → sdv_installer-0.3.1.dev0}/sdv_installer/authentication/authentication.py

@@ -28,13 +28,13 @@ def authenticate_user_and_license_key(username, license_key):
         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.
+
+    Raises:
+        InvalidLoginCredentials:
+            If the user has provided invalid login credentials.
     """
     post_data = {'username': username, 'license_key': license_key}
     try: