[Python-modules-commits] [python-vagrant] 07/13: add proper descriptions to debian/control

[Hans-Christoph Steiner]

This is an automated email from the git hooks/post-receive script.

eighthave pushed a commit to branch master
in repository python-vagrant.

commit a4e54dc47dd11caa8c7733dc5e42bd5c6d9a079e
Author: Hans-Christoph Steiner <hans at eds.org>
Date:   Fri Jun 17 10:11:12 2016 +0200

    add proper descriptions to debian/control
---
 debian/control | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 74 insertions(+), 8 deletions(-)

diff --git a/debian/control b/debian/control
index 590aa9b..0ab1d58 100644
--- a/debian/control
+++ b/debian/control
@@ -19,10 +19,43 @@ Architecture: all
 Depends: ${misc:Depends},
          ${python:Depends},
 XB-Python-Version: ${python:Versions}
-Description: Python library to interact with Git repositories - Python 2.7
- python-vagrant provides object model access to a Git repository, so Python can be
- used to manipulate it. Repository objects can be opened or created, which can
- then be traversed to find parent commit(s), trees, blobs, etc.
+Description: Python bindings for interacting with Vagrant virtual machines
+ 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 project began to
+ create Python bindings for Vagrant to programmatically access vagrant
+ boxes using Fabric. 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 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.
  .
  This package provides the Python 2.7 module.
 
@@ -31,9 +64,42 @@ Architecture: all
 Depends: ${misc:Depends},
          ${python3:Depends},
 XB-Python-Version: ${python3:Versions}
-Description: Python library to interact with Git repositories - Python 3.x
- python-vagrant provides object model access to a Git repository, so Python can be
- used to manipulate it. Repository objects can be opened or created, which can
- then be traversed to find parent commit(s), trees, blobs, etc.
+Description: Python bindings for interacting with Vagrant virtual machines
+ 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 project began to
+ create Python bindings for Vagrant to programmatically access vagrant
+ boxes using Fabric. 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 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.
  .
  This package provides the Python 3.x module.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-vagrant.git