2.2. SteelScript Installation - Linux / Mac

This page provides step-by-step instructions for installing SteelScript and associated modules in the system-wide site-packages directory on a Linux or Mac. This will make SteelScript available to all users.

2.2.1. Dependencies

2.2.2. Python

You must already have Python installed on your system to continue. If not, please install Python from python.org or ask your system adminstrator to install Python. You will need either Python 2.6.x or 2.7.x to use the FlyScript SDK.

Check that Python is installed and running the approriate version:

$ python -V
Python 2.7.3

2.2.3. Online Installation

Use this method if the target system has access to the internet. If access is limited, see below for Offline Installation via pip instructions.

  1. Install the pip utility via easy_install:
$ sudo easy_install pip

``pip`` is manages Python package installation and upgrade.
  1. (optional) Take a look at virtualenv - a tool that provides isolated Python environments. This allows you to install packages without admin privileges.

  2. Install steelscript:

    $ sudo pip install steelscript
    

    Note

    Omit sudo if you are using virtualenv, as admin privileges are not required

    This package provides the common functions used by all other SteelScript product specific modules. Additional Python dependencies such as Python requests may also be installed if it not already present.

  3. Install one or more product specific SteelScript modules:

    $ sudo pip install steelscript.netprofiler
    $ sudo pip install steelscript.netshark
    

    See http://github.com/riverbed for a complete list of additional SteelScript packages available.

  1. Verify your installation by running a simple test (note, you may have to refresh your path with rehash if the command is not found):

    $ steel about
    
    Installed SteelScript Packages
    Core packages:
      steelscript                               0.9.0
      steelscript.netprofiler                   0.9.0
      steelscript.netshark                      0.9.0
    
    Application Framework packages:
      None
    
    Paths to source:
      /ws/ss/steelscript
      /ws/ss/steelscript-netprofiler
      /ws/ss/steelscript-netshark
    
    (add -v or --verbose for further information)
    

2.2.4. Offline Installation via pip

Use this method to install SteelScript when the target system:

  • does not have direct access to the internet
  • does have the pip command available

Using pip is the preferred approach, as it will make upgrade easier down the road.

Essentially you must transfer the necessary packages and dependencies to the target system manually and then install each package separately.

  1. Upload the following packages to the target system:

    Required:

    Optional product specific packages:

  2. Use pip to install each tarball:

    $ sudo pip install requests-0.2.1.tar.gz
    $ sudo pip install steelscript-0.9.0.tar.gz
    

    Repeat for each product specific steelscript package as well.

    Note

    Omit sudo if you are using virtualenv, as admin privileges are not required

  3. Verify your installation with steel about

2.2.5. Manual Installation without pip

Use this method to install SteelScript when the target system:

  • does not have direct access to the internet
  • does not have the pip command available
  1. Upload the packages to the target system as described in above in Step 1.

  2. Create a suitable working directory and extract all packages:

    $ mkdir /steelscript
    $ tar xvzf requsts-0.2.1.tar.gz
    $ tar xvzf steelscript-0.9.0.tar.gz
    

    Extract all packages that were downloaded, including the product specific packages.

  3. Next, install each package in order:

    $ cd /steelscript/requests-0.2.1
    $ python setup.py install
    
    $ cd /steelscript/steelscript-0.9.0
    $ python setup.py install
    

    Repeat for each package extracted.

  4. Verify your installation with steel about

2.2.6. Upgrade

If you need to upgrade SteelScript package to a newer version, and you are offline, simply repeat the above installation steps. This will install the latest version alongside the older version. Normally you do not need to delete the older version.

With internet access, any package can be updated with pip install -U <package> as follows:

$ pip install -U steelscript

The -U stands for upgrade – this will check for a more recent version of the named package, and if available, it will download it and update.