Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document explains the setup of the Python SDK for Squirro (SquirroClient). It starts with the setup of Python itself, a step that is optional if you already have Python installed.

Table of Contents

Table of Contents
outlinetrue
excludeTable of Contents

Python 3.6 (or newer)

First, download the latest version of Python 3.6 from the official Website. If you want to be sure you are installing a fully up-to-date version then use the “Windows Installer” link from the home page of the python.org download site.
The Windows version is provided as an MSI package. To install it manually, just double-click the file. The MSI package format allows Windows administrators to automate installation with their standard tools.

By design, Python installs to a directory with the version number embedded, e.g. Python version 3.6 will install normally in a Python36 folder under the User's Appdata, so that you can have multiple versions of Python on the same system without conflicts.
Of course, only one interpreter can be the default application for Python file types. You can instruct the installer to also add the newly installed Python to the PATH.

Alternatively, that can be adjusted manually:

Assuming that your Python installation is in C:\Python36, add this to your PATH:

Code Block
C:\Python36\;C:\Python36\Scripts\

You can do this easily by running the following in PowerShell:

Code Block
[Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Python36\;C:\Python36\Scripts\", "User")

SquirroClient

Finally we can install the Squirro SDK. For this, execute the following commands. They are all executed on the Command Prompt of Windows.

Code Block
pip install SquirroClient

To upgrade to the latest version you can run:

Code Block
pip install --upgrade SquirroClient

To see with version is currently installed:

Code Block
pip freeze

If pip is not an option for you, you can download and install the SquirroClient manually:

...

Download the package from https://pypi.python.org/pypi/SquirroClient

...

Extract the archive and enter the folder

Execute the following command:

...

can now be found at SquirroClient Installation on the Squirro Docs site.