Skip to main content

Parser to extract data from a Vagrantfile into a data struct readable by python

Project description

Build Status


Parses a vagrant file into a python object for inspect. Mainly used to read and build Vagrant file in python. I built this to help me write a utility in python which can build projects and convert Vagrantfiles to packer files.

Supported Directives

  • Most vm.config directives,

  • Chef provisioner

  • Shell provisioner

  • VB provider


After it’s on the pip server, you should be able to install on the client by running

$ pip install pyvagrantfile


When this is ready to be deployed, you can upload it to the pip server

$ cd $WORKSPACE/pyvagrantfile
$ python sdist upload




When doing development and testing, it’s good practice to use a virtualenv. A virtualenv is a sandboxed python environment which does not modify the system python installation You can install one as follows:

$ pip install virtualenv
$ cd $WORKSPACE/pyvagrantfile
$ virtualenv venv
$ . ./venv/bin/activate

Now that you have a working virtualenv, you can install the utility in development mode. Keep in mind that the ‘activate’ step, is valid only for a single session. If you close the terminal you’ll have to run venv/bin/activate again. You can now run pip, python, and pyvagrantfile while only referring to the local python environment created in $WORKSPACE/pyvagrantfile. You can see this by running:

(pyvagrantfile)$ which pip
(pyvagrantfile)$ which python

Development Mode

When testing this utility, you can install it and still edit the source files as follows:

$ cd $WORKSPACE/pyvagrantfile
$ pip install --editable .


I intially tried to use pyPEG, but could not get a handle on it, so for now, we use a custom state parser. I want to move this to a PEG parser to make it easier to manage, but in the spirit of minimum viable product, it’s up and out.

  • This is currently way too specific. Needs to be rewritten to parse general ruby structures and extract details out of it, rather than looking for particular vagrant configurations.

  • Port parser from state parser to PEG parser.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvagrantfile-0.5.11.tar.gz (7.0 kB view hashes)

Uploaded source

Built Distribution

pyvagrantfile-0.5.11-py2.py3-none-any.whl (9.2 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page