SDV Installer Reference

This page provides a reference for all the capabilities of the SDV Installer.

👉 For a step-by-step installation guide, please see the main Installation Instructions page instead.

Check Requirements

Use this command to verify whether the current environment meets the Technical Requirements needed to install SDV Enterprise.

sdv-installer check-requirements

Flags: (None)

List-Packages

Use the list-packages command list all the packages that you have access to.

sdv-installer list-packages

The installer lists all the packages you have access to — SDV Enterprise, as well as any additional bundles you have purchased. But it will not download or install any of them.

SDV Enterprise:
sdv-enterprise

SDV Bundles:
bundle-cag
bundle-xsynthesizers

Authentication: Providing credentials in the command optional. If you do not provide any, then SDV Installer interactively prompts you to enter them on your screen.

• --username and --license-key: Provide the username (email) and license key. Please be sure you copy-paste exactly as provided by DataCebo.

  sdv-installer list-packages --username [email protected] --license-key 123

• --credentials: As an alternative to providing your username and license key, you can instead provide a JSON filepath that contains your credentials. The JSON should contain a key called "username" that maps to your username and a key called "license_key" that maps to your license key.

  {
      "username": "[email protected]",
      "license_key": "123"
  }

Install

This is the basic install command that you can use to install packages from our server (or from local folder that already contains the packages).

sdv-installer install --username [email protected] --license-key 123

The installer installs all the packages you have access to — SDV Enterprise, as well as any additional bundles you have purchased.

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.

Authentication: Providing credentials in the command is optional. If you do not provide any, then SDV Installer interactively prompts you to enter them on your screen.

• --username and --license-key: Provide the username (email) and license key. Please be sure you copy-paste exactly as provided by DataCebo.

  sdv-installer install --username [email protected] --license-key 123

• --credentials: As an alternative to providing your username and license key, you can instead provide a JSON filepath that contains your credentials. The JSON should contain a key called "username" that maps to your username and a key called "license_key" that maps to your license key.

  {
      "username": "[email protected]",
      "license_key": "123"
  }

Flags:

• --upgrade: If you've already installed any of the SDV Enterprise packages, this flag will install the updated version (if one exists). If you haven't yet installed SDV Enterprise, it will install the most recent version.

• --folder <folder_name>: If you provide the name of a folder, SDV Installer assumes you have already downloaded the packages that you need into the local folder. It will install those packages offline instead of accessing them from our server. (In this case, username/license key credentials are not needed because you already have the folder downloaded.)

• --package <package_name>: If you provide the name of a package, SDV Installer will only install the specific package (as opposed to all of them). Note that you must have permissions to access that particular package; use list-packages to see the names.

• --options <optional_dependencies>: For some packages , you may want to pass in optional dependencies for your particular usage. List the dependencies using this flag. (This flag should be used in conjunction with the --package flag.)

• --debug: When this flag is set, SDV Installer will print out all the commands it is running internally (with pip) as well as their outputs. This is useful when debugging the SDV Installer.

Download

Use the download command to download the packages from our server and save them locally in a folder. This command will not actually install those packages. This is useful if you want to complete the installation offline at a later point or on a different machine. (See the instructions for Download & Install Offline).

sdv-installer download --folder sdv-enterprise/ --username [email protected] --license-key 123

The installer downloads all the packages you have access to — SDV Enterprise, as well as any additional bundles you have purchased.

Downloading SDV Enterprise:
sdv-enterprise (version 0.30.0) - Downloaded!

Downloading Bundles:
bundle-cag - Downloaded!
bundle-xsynthesizers - Downloaded!

Success! All packages have been downloaded. Please install the packages to use SDV Enterprise.

Authentication: Providing credentials in the command is optional. If you do not provide any, then SDV Installer interactively prompts you to enter them on your screen.

• --username and --license-key: Provide the username (email) and license key. Please be sure you copy-paste exactly as provided by DataCebo.

  sdv-installer download --username [email protected] --license-key 123 --folder sdv-enterprise/

• --credentials: As an alternative to providing your username and license key, you can instead provide a JSON filepath that contains your credentials. The JSON should contain a key called "username" that maps to your username and a key called "license_key" that maps to your license key.

  {
      "username": "[email protected]",
      "license_key": "123"
  }

Flags:

• (required) --folder <folder_name>: Download the packages locally into the provided folder name. By default, the packages will be downloaded for your current environment.

• --python-version <version_num>: Use this when you want to download packages for a different version of Python than the one you currently have.

  • Note that the version number you provide should not have decimal point or the patch version. For example, if you want Python version 3.11.13, provide 311.

  • Make sure the Python version is supported by SDV Enterprise. For more details, see Technical Requirements.

• --platform <platform_name>: Use this when you want to download packages for a different OS platform than the one you are currently on. Options are listed below based on the machine:

How do I know which platform tag to use? Each machine is compatible with one or multiple different platform tags. Run the code below to see which platform tags are compatible your machine.

from packaging import tags

supported_tags = []
for tag in tags.sys_tags():
    if tag.platform not in supported_tags:
        supported_tags.append(tag.platform)

print(supported_tags)

This prints out a list of tags. From that list, pick any one that matches the available SDV Enterprise tags listed below:

• Windows: win_amd64

• Linux: musllinux_1_2_x86_64.whl , manylinux2014_x86_64, manylinux_2_17_x86_64, or manylinux_2_28_x86_64

• MacOS: macosx_11_0_x86_64 or macosx_11_0_arm64

Please note that the available tags for SDV Enterprise may change as new platforms and infrastructure becomes available. If you cannot find a tag to use, or need help picking one, please contact us.

• --package <package_name>: If you provide the name of a package, SDV Installer will only download the specific package (as opposed to all of them). Note that you must have permissions to access that particular package; use list-packages to see the names.

• --options <optional_dependencies>: For some packages , you may want to pass in optional dependencies for your particular usage. List the dependencies using this flag. (This flag should be used in conjunction with the --package flag.)

• --debug: When this flag is set, SDV Installer will print out all the commands it is running internally (with pip) as well as their outputs. This is useful when debugging the SDV Installer.

Uninstall

Use this command to uninstall all the SDV-related packages that you had previously installed in your environment.

sdv-installer uninstall

Flags: (None)