Installation

Note

In January 2026, a more intuitive method of installation using PyPi was rolled out to NLDS users. The instructions below are for this new installation method.

To use the NLDS, first you must install the client software. This guide will show you how to install it into a Python virtual-environment (virtualenv) in your user space or home directory.

  1. Log onto the machine where you wish to install the NLDS client into your user space or home directory.

  2. Create a Python virtual environment:
    python3 -m venv ~/nlds-client

  3. Activate your new virtual environment:
    source ~/nlds-client/bin/activate

  4. It is a good idea to upgrade your version of pip - otherwise some modules may fail to install:
    pip install --upgrade pip

  5. Install the nlds-client package from PyPi:
    pip install nlds-client

Upgrading to v1.0.17

Note

In January 2026, hosting of the NLDS client was moved to PyPi. Previous installations of nlds-client from GitHub may have to be removed using pip uninstall.

  1. Activate your virtual environment:
    source ~/nlds-client/bin/activate

  2. Upgrade using the latest nlds-client package from GitHub:
    pip install --upgrade nlds-client

  3. If the above point produces an error, then you may need to uninstall your previous version of nlds-client and install the new one: pip uninstall nlds-client
    pip install nlds-client

  4. Check if you have the right client by issuing the command:
    nlds --version
    The output should start with: Near Line Data Store client 1.0.12

  5. You may need to update your NLDS client config. This can be done using the init command: nlds init
    This will ask for your user name and password, regenerate your OAuth access tokens and object storage keys, and make any necessary changes in your config file.