The sections below will go over how to install the Warthog client from the Python Package Index (PyPI) or how to install it from source. Both ways to install the client can be done globally on a machine or within the context of a virtualenv.
These instructions assume that you have the following things available.
Warthog depends on the following libraries / projects. If you have Python installed and use the pip tool for installation, these should be installed automatically.
Install from PyPI¶
If you’re planning on installing from PyPI, the process is pretty easy. Depending on how you want to use the client, you have a few options.
You can install the client globally on a machine (using the system Python version) and it will be available for all users of the machine. This will typically require root or administrator permissions.
$ pip install warthog
You can also install the client into a virtual environment. A virtual environment is a self-contained Python installation into which you can install whatever you’d like without root or administrator permissions. Packages installed in this environment will only be available in the context of that environment.
# Create your new virtual environment $ virtualenv my-warthog-install # Enter the virtual environment $ source my-warthog-install/bin/activate # Install the Warthog client $ pip install warthog
Install from Source¶
First you’ll need to get the source code of the client using Git.
$ git clone https://github.com/smarter-travel-media/warthog.git
Like installation from PyPI, installation from source can be done globally for all users of a machine. As above, this will typically require root or administrator permissions.
$ cd warthog && pip install .
You can also install the client from source into a virtual environment.
# Create your new virtual environment $ virtualenv my-warthog-install # Enter the virtual environment $ source my-warthog-install/bin/activate # Install the client from the source checkout we made above $ cd warthog && pip install .