Python bindings for interacting with Vagrant virtual machines.
Project description
## 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 box (`up`).
- Terminating a Vagrant box (`destroy`).
- Halting a Vagrant box without destroying it (`halt`).
- Querying the status of a box (`status`).
- Getting ssh configuration information useful for SSHing into the box. (`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 - up() accepts no_provision and there is a provision() method.
- Using sandbox mode from the Sahara gem (https://github.com/jedi4ever/sahara).
This package is _alpha_ 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.
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. -Todd DeLuca
## 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.
## Requirements
- Vagrant 1.1 or greater (Currently tested with 1.1.5).
- Vagrant requires VirtualBox (e.g. VirtualBox 4.2.10) or another 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.
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 box (`up`).
- Terminating a Vagrant box (`destroy`).
- Halting a Vagrant box without destroying it (`halt`).
- Querying the status of a box (`status`).
- Getting ssh configuration information useful for SSHing into the box. (`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 - up() accepts no_provision and there is a provision() method.
- Using sandbox mode from the Sahara gem (https://github.com/jedi4ever/sahara).
This package is _alpha_ 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.
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. -Todd DeLuca
## 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.
## Requirements
- Vagrant 1.1 or greater (Currently tested with 1.1.5).
- Vagrant requires VirtualBox (e.g. VirtualBox 4.2.10) or another 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-vagrant-0.3.1.tar.gz
(15.3 kB
view details)
File details
Details for the file python-vagrant-0.3.1.tar.gz
.
File metadata
- Download URL: python-vagrant-0.3.1.tar.gz
- Upload date:
- Size: 15.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd1733dd6da430d2971a4298ae5c77ae9d6928d14812d6ee5477a9abe56e12ce |
|
MD5 | 6ba6fe95d40b142669f753cc562aebf3 |
|
BLAKE2b-256 | 25ae31d38413915cae9a5e11a80815f032bedf66221d94accad1944ac18dbc14 |