skip to navigation
skip to content

Not Logged In

python-vagrant 0.5.5

Python bindings for interacting with Vagrant virtual machines.

## Introduction

Python-vagrant is a python module that provides a _thin_ wrapper around the
`vagrant` command line executable, allowing programmatic control of Vagrant
virtual machines (boxes). This module is useful for:

- Starting a Vagrant virtual machine (VM) (`up`).
- Terminating a Vagrant VM (`destroy`).
- Halting a Vagrant VM without destroying it (`halt`).
- Querying the status of a VM or VMs (`status`).
- Getting ssh configuration information useful for SSHing into the VM. (`host`, `port`, ...)
- Running `vagrant` commands in a multi-VM environment
http://vagrantup.com/v1/docs/multivm.html by using `vm_name` parameter.
- Initializing the VM based on a named base box, using init().
- Adding, Removing, and Listing boxes (`box add`, `box remove`, `box list`).
- Provisioning VMs - up() accepts options like `no_provision`, `provision`, and `provision_with`, and there is a `provision()` method.
- Using sandbox mode from the Sahara gem https://github.com/jedi4ever/sahara)

This project begain because I wanted python bindings for Vagrant so I could
programmatically access my vagrant box using Fabric. Drop me a line to let me
know how you use python-vagrant. I'd love to share more use cases. -Todd DeLuca


## Versioning and API Stability

This package is _beta_ and its API is not guaranteed to be stable. The API
attempts to be congruent with the `vagrant` API terminology, to facilitate
knowledge transfer for users already familiar with Vagrant. Over time, the
python-vagrant API has changed to better match the underling `vagrant` CLI and
to evolve with the changes in that CLI.

The package version numbering is in the form `0.X.Y`. The initial `0` reflects
the _beta_ nature of this project. The number `X` is incremented when
backwards-incompatible changes occur. The number `Y` is incremented when
backwards-compatible features or bug fixes are added.


## Requirements

- Vagrant 1.4 or greater (currently tested with 1.7.2). Using the latest version
of Vagrant is strongly recommended.
- Vagrant requires VirtualBox, VMWare, or another supported provider.
- Python 2.7 (the only version this package has been tested with.)
- The Sahara gem for Vagrant is optional. It will allow you to use
`SandboxVagrant`.


## Installation

### Install from pypi.python.org

Download and install python-vagrant:

pip install python-vagrant

### Install from github.com

Clone and install python-vagrant

cd ~
git clone git@github.com:todddeluca/python-vagrant.git
cd python-vagrant
python setup.py install


## Usage

A contrived example of starting a vagrant box (using a Vagrantfile from the
current directory) and running a fabric task on it:

import vagrant
from fabric.api import env, execute, task, run

@task
def mytask():
run('echo $USER')


v = vagrant.Vagrant()
v.up()
env.hosts = [v.user_hostname_port()]
env.key_filename = v.keyfile()
env.disable_known_hosts = True # useful for when the vagrant box ip changes.
execute(mytask) # run a fabric task on the vagrant host.

Another example showing how to use vagrant multi-vm feature with fabric:

import vagrant
from fabric.api import *

@task
def start(machine_name):
"""Starts the specified machine using vagrant"""
v = vagrant.Vagrant()
v.up(vm_name=machine_name)
with settings(host_string= v.user_hostname_port(vm_name=machine_name),
key_filename = v.keyfile(vm_name=machine_name),
disable_known_hosts = True):
run("echo hello")

By default python vagrant instances are quiet, meaning that they capture stdout
and stderr. For a "loud" instance, use `vagrant.Vagrant(quiet_stdout=False)`.
Set `quiet_stderr=False` for an even louder version.


## Contribute

If you use python and vagrant and this project does not do what you want,
please open an issue or a pull request on github at
https://github.com/todddeluca/python-vagrant

Please see CHANGELOG.md for a detailed list of contributions and authors.

When making a pull request, please include unit tests that test your changes
and make sure any existing tests still work. See the Testing section below.


## Testing

Running the full suite of tests might take 10 minutes or so. It involves
downloading boxes and starting and stopping virtual machines several times.

Run the tests from the top-level directory of the repository:

nosetests

Here is an example of running an individual test:

nosetests tests.test_vagrant:test_boxes  
File Type Py Version Uploaded on Size
python-vagrant-0.5.5.tar.gz (md5) Source 2015-03-21 23KB
  • Downloads (All Versions):
  • 115 downloads in the last day
  • 975 downloads in the last week
  • 2618 downloads in the last month