Package: vagpy
IntroductionPython-vagrant is a python module that provides athinwrapper around thevagrantcommand 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, ...)Runningvagrantcommands in amulti-VM environmentby usingvm_nameparameter.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 likeno_provision,provision, andprovision_with, and there is aprovision()method.Using sandbox mode from theSaharagem.This project began 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 DeLucaVersioning and API StabilityThis package isbetaand its API is not guaranteed to be stable. The API
attempts to be congruent with thevagrantAPI terminology, to facilitate
knowledge transfer for users already familiar with Vagrant. Over time, the
python-vagrant API has changed to better match the underlingvagrantCLI and
to evolve with the changes in that CLI.The package version numbering is in the form0.X.Y. The initial0reflects
thebetanature of this project. The numberXis incremented when
backwards-incompatible changes occur. The numberYis incremented when
backwards-compatible features or bug fixes are added.RequirementsVagrant 2.2 or greater. Using the latest version of Vagrant is strongly
recommended.Vagrant requires VirtualBox, VMWare, or another supported provider.Python 3.9 or newer.The Sahara gem for Vagrant is optional. It will allow you to useSandboxVagrant.InstallationInstall from pypi.python.orgDownload and install python-vagrant:pipinstallpython-vagrantInstall from github.comClone and install python-vagrantcd~
gitclonegit@github.com:pycontribs/python-vagrant.gitcdpython-vagrant
pythonsetup.pyinstallUsageA contrived example of starting a vagrant box (using a Vagrantfile from the
current directory) and running a fabric task on it:importvagrantfromfabric.apiimportenv,execute,task,run@taskdefmytask():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:importvagrantfromfabric.apiimport*@taskdefstart(machine_name):"""Starts the specified machine using vagrant"""v=vagrant.Vagrant()v.up(vm_name=machine_name)withsettings(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, usevagrant.Vagrant(quiet_stdout=False).
Setquiet_stderr=Falsefor an even louder version.Interacting With the Vagrant SubprocessTheVagrantclass works by executingvagrantcommands in a subprocess and
interpreting the output. Depending on the needs of the user, the communication
to and from the subprocess can be tailored by altering its environment and
where it sends its stdout and stderr.Silencing the Stdout or Stderr of the Vagrant SubprocessThe stdout and stderr of the underlying vagrant process can be silenced by
using theout_cmanderr_cmparameters, or by using thequiet_stdoutandquiet_stderrparameters ofVagrant.__init__.Usingout_cmanderr_cmto redirect stdout and stderr to/dev/null:v=vagrant.Vagrant(out_cm=vagrant.devnull_cm,err_cm=vagrant.devnull_cm)v.up()# normally noisyUsingquiet_stdoutandquiet_stderrto redirect stdout and stderr to/dev/null:v=vagrant.Vagrant(quiet_stdout=True,quiet_stderr=True)v.up()# normally noisyThese are functionally equivalent.Logging the Stdout or Stderr of the Vagrant SubprocessA user might wish to direct the stdout and stderr of a vagrant subprocess to
a file, perhaps to log and analyze the results of an automated process. This
can be accomplished using theout_cmanderr_cmparameters ofVagrant.__init__.For example, log the stdout and stderr of the subprocess to the file
'deployment.log':log_cm=vagrant.make_file_cm('deployment.log')v=vagrant.Vagrant(out_cm=log_cm,err_cm=log_cm)v.up()# normally noisyAltering the Environment of the Vagrant SubprocessIt's possible to communicate with the Vagrant subprocess using environment
variables. TheVagrantfilecould expect environment variables to be present
and act accordingly. The environment variables can be set bypython-vagrant.importvagrantv=vagrant.Vagrant()os_env=os.environ.copy()os_env['USE_NFS']='1'v.env=os_envv.up()# will pass env to the vagrant subprocessAlternatively, the environment can be passed at instantiation time.importvagrantos_env=os.environ.copy()os_env['USE_NFS']='1'v=vagrant.Vagrant(env=env)assertv.envisenv# Truev.up()# will pass env to the vagrant subprocessContributeIf you use python and vagrant and this project does not do what you want,
please open an issue or a pull request onGitHub.Please seeCHANGELOG.mdandReleasesfor a detailed list of updates, 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.TestingRunning 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:tox-epyHere is an example of running an individual test:tox-epy---ktests.test_vagrant:test_boxesManual test of functionality for controlling where the vagrant subcommand
output is sent -- console or devnull:>>> import vagrant
>>> import os
>>> vagrantfile = '/Users/tfd/proj/python-vagrant/tests/vagrantfiles/single_box'
>>> # Demonstrate a quiet Vagrant.  Equivalent to out_cm=vagrant.devnull_cm
... v1 = vagrant.Vagrant(vagrantfile)
>>> v1.destroy() # output to /dev/null
>>> # Demonstrate a loud Vagrant.  Equivalent to out_cm=vagrant.stdout_cm
... v2 = vagrant.Vagrant(vagrantfile, quiet_stdout=False)
>>> v2.destroy() # stdout sent to console
==> default: VM not created. Moving on...
>>> # Demonstrate that out_cm takes precedence over quiet_stdout=True
... v3 = vagrant.Vagrant(vagrantfile, out_cm=vagrant.stdout_cm)
>>> v3.destroy() # output to console
==> default: VM not created. Moving on...
>>> # Demonstrate a quiet Vagrant using devnull_cm directly
... v4 = vagrant.Vagrant(vagrantfile, out_cm=vagrant.devnull_cm)
>>> v4.destroy() # output to console
>>>