vsphere-automation-sdk-python/README.md

# VMware vSphere Automation SDK for Python
## Table of Contents
* [Abstract](#abstract)
* [Table of Contents](https://github.com/vmware/vsphere-automation-sdk-python-samples#table-of-contents)
* [Getting Started](https://github.com/vmware/vsphere-automation-sdk-python-samples#getting-started)
  * [Prerequisites](https://github.com/vmware/vsphere-automation-sdk-python-samples#prerequisites)
  * [Running the Samples](https://github.com/vmware/vsphere-automation-sdk-python-samples#running-the-samples)
* [Submitting Samples](https://github.com/vmware/vsphere-automation-sdk-python-samples#submitting-samples)
  * [Required Information](https://github.com/vmware/vsphere-automation-sdk-python-samples#required-information)
  * [Suggested Information](https://github.com/vmware/vsphere-automation-sdk-python-samples#suggested-information)
* [Resource Maintenance](https://github.com/vmware/vsphere-automation-sdk-python-samples#resource-maintenance)
  * [Maintenance Ownership](https://github.com/vmware/vsphere-automation-sdk-python-samples#maintenance-ownership)
  * [Filing issues](https://github.com/vmware/vsphere-automation-sdk-python-samples#filing-isssues)
  * [Resolving issues](https://github.com/vmware/vsphere-automation-sdk-python-samples#resolving-issues)
* [Additional Resources](https://github.com/vmware/vsphere-automation-sdk-python-samples#additional-resources)
  * [Discussions](https://github.com/vmware/vsphere-automation-sdk-python-samples#discussions)
  * [VMware Sample Exchange](https://github.com/vmware/vsphere-automation-sdk-python-samples#vmware-sample-exchange)
* [LICENSE AGREEMENT](https://github.com/vmware/vsphere-automation-sdk-python-samples#license-agreement)

## Abstract
This document describes the vSphere Automation Python SDK samples that use the vSphere Automation python client library. Additionally, some of the samples demonstrate the combined use of the vSphere Automation and vSphere APIs. To support this combined use, the vSphere Automation Python SDK samples require the vSphere Management SDK packages (pyVmomi) to be installed on the client. The examples have been developed to work with python 2.7, 3.3, 3.4 and 3.5.

## Getting Started
### Prerequisites
#### Required:
The below items need to be installed for running the samples:
- Python 2.7, 3.3, 3.4 or 3.5
- vCenter Server 6.5
- Installing SDK and 3rd party libraries
  The supplied python libs can be installed using **pip install**; For details on how to install python packages using pip please refer to [pip user guide](https://pip.pypa.io/en/stable/user_guide/)
  - vapi_runtime, vapi_common_client and vapi_client_bindings
  
    `pip install lib/vapi_client_bindings-2.5.0.zip --find-links=lib/`
  - pyVmomi
  
    This library is needed for accessing/manipulating vCenter Server managed objects using vSphere APIs; For more information please refer to [vmware pyVmomi](https://github.com/vmware/pyvmomi)
    
    `pip install pyvmomi`
  - pyOpenSSL
  
    This requires python cryptography package to be installed as a pre-requisite.
    
    Please follow the detailed instruction from [installing cryptography dev documentation](https://cryptography.io/en/latest/installation/)
    
    VMware strongly recommends using openssl version 1.0.1j or, higher. SDK and samples are tested against openssl version >= 1.0.1j.
    
    pyOpenSSL version 0.14 is needed for the SDK (vapi_runtime) and samples. For details on how to install the package please go to pypi.python.org/pypi/pyOpenSSL/0.14.
  - lxml

    `pip install lxml`
  - suds(suds-jurko)
  
    This library is needed for lookup service queries; For more information please refer to [suds Documentation](https://fedorahosted.org/suds/wiki/Documentation)
    
    `pip install suds`
    
    Use suds-jurko for python 3.x
    
    `pip install suds-jurko`

### Running the Samples
Please refer to running a vcenter sample for detailed steps to run a vCenter sample. 
Please refer to running a workflow sample for detailed steps to run a vCenter Single Sign-On, Content Library or Tagging sample.
* run_sample.sh is needed for running the samples in UNIX/mac OS X environment
* run_sample.bat is a windows bat file needed for running the samples in windows

### API Documentation and Programming Guide
The API documentation for the samples can be found here : TODO

The programming guide for vSphere Automation SDK for Python can be found here:  TODO

## Submitting samples
The following information must be included in the README.md (TODO: header of the file or a separate md file?) for each submitted sample.
* Author Name
  * This can include full name, email address or other identifiable piece of information that would allow interested parties to contact author with questions.
* Date
  * Date the sample was originally written
* Minimal/High Level Description
  * What does the sample do ?
* vSphere version against which the sample was developed/tested
* SDK version against which the sample was developed/tested (TODO: do we need SDK version?)
* Python version against which the sample was developed/tested
* Any KNOWN limitations or dependencies

## Resource Maintenance
### Maintenance Ownership
Ownership of any and all submitted samples are maintained by the submitter.
### Filing Issues
Any bugs or other issues should be filed within GitHub by way of the repository’s Issue Tracker.
### Resolving Issues
Any community member can resolve issues within the repository, however only the board member can approve the update. Once approved, assuming the resolution involves a pull request, only a board member will be able to merge and close the request.

### VMware Sample Exchange
It is highly recommended to add any and all submitted samples to the VMware Sample Exchange:  <https://developercenter.vmware.com/samples>

Sample Exchange can be allowed to access your GitHub resources, by way of a linking process, where they can be indexed and searched by the community. There are VMware social media accounts which will advertise resources posted to the site and there's no additional accounts needed, as the VMware Sample Exchange uses MyVMware credentials.     

## LICENSE AGREEMENT
License Agreement: <https://<path to license file>

# Repository Administrator Resources
## Table of Contents
* Board Members
* Approval of Additions

## Board Members

Board members are volunteers from the SDK community and VMware staff members, board members are not held responsible for any issues which may occur from running of samples from this repository.

Members:

## Approval of Additions
Items added to the repository, including items from the Board members, require 2 votes from the board members before being added to the repository. The approving members will have ideally downloaded and tested the item. When two “Approved for Merge” comments are added from board members, the pull can then be committed to the repository.