1.4. SteelScript SteelHead Installation

The SteelScript SteelHead Package is distributed entirely as Python packages via the Python Package Index PyPI. This makes it easy to install and upgrade the steelhead pacakge.

1.4.1. Quick Install


  1. steelscript installed (if not see SteelScript Installation)
  2. Running Linux / Mac (for Windows, see Detailed Installation below)
  3. Developer tools installed (gcc/g++ or the like)

If you can check off all of the above, simply run (in a virtualenv):

$ steel install --steelhead

This will install all the additional packages related to the package of SteelScript SteelHead.

1.4.2. Detailed Installation

If you’re familiar with pip and Python package installation, the latest stable versions of these packages are hosted on PyPI - the Python Package Index.

The following packages are related to the SteelScript SteelHead:

  • steelscript.steelhead (PyPI, GitHub) - the core modules and data files for the SteelScript SteelHead
  • steelscript.cmdline (PyPI, GitHub) - python modules for interacting with transport types, such as telnet and ssh.

The primary package is steelscript.steelhead. Installing this will pull in a number of dependencies. The exact dependencies will change over time as new features are added. When installing via pip, the dependencies will be installed automatically.

There is one package dependency that deserves special attention:

The Pycrypto package contains a collection of cryptographic modules implementing various algorithms and protocols. The package has a large portion written in C, thus it must be compiled. For Linux / Mac, it is usually sufficient just to ensure that the developer tools are installed. For Windows, it is recommended to install a special compiler, Microsoft Visual C++ Compiler for Python 2.7, which you can download from here. This package provides the means to compile the Pycrypto package from source. Alternatively, you can install the package from pre-compiled distributions, available from here. Once the compiler or Pycrypto is installed, executing again the command steelscript install --steelhead will install all packages related to the SteelScript Steelhead.

Other than the special case described above, the installation is identical to installation for core SteelScript. Follow the directions described in one of the guides below to install steelscript along with any product specific packages. Then install steelscript.steelhead in the same manner:

You can check your installation using steel about:

$ steel about

Installed SteelScript Packages
Core packages:
  steelscript                               0.9.6
  steelscript.cmdline                       0.5.0
  steelscript.netprofiler                   0.9.4
  steelscript.netshark                      0.9.4
  steelscript.steelhead                     0.5.0
  steelscript.wireshark                     0.9.4

Application Framework packages:
  steelscript.appfwk.business-hours         0.9.6

REST tools and libraries:

Paths to source:

(add -v or --verbose for further information)