Skip to content

Commit

Permalink
Update README.md - pre-release notes
Browse files Browse the repository at this point in the history
Additional notes for community standards.
  • Loading branch information
Shawn Hartsock committed Aug 4, 2014
1 parent 8bbc7b4 commit b306002
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,43 @@
[![Build Status](https://travis-ci.org/vmware/pyvmomi.svg?branch=master)](https://travis-ci.org/vmware/pyvmomi)
[![Downloads](https://pypip.in/download/pyvmomi/badge.png)](https://pypi.python.org/pypi/pyvmomi/)

pyVmomi is the Python SDK for the VMware vSphere API that allows you to manipulate ESX, ESXi, and vCenter.
pyVmomi is the Python SDK for the VMware vSphere API that allows you to manage ESX, ESXi, and vCenter.

Getting Started
================
To get started, check out the samples project at http://vmware.github.io/pyvmomi-community-samples/

* community discussion on IRC freenode.net channels [#pyvmomi and #pyvmomi-dev](http://webchat.freenode.net/?channels=#pyvmomi,#pyvmomi-dev)

You can install this as a package. The official release is availabe using pip, just run `pip install pyvmomi`. To install the version listed here use `python setup.py develop` for development install or `python setup.py install`. The master is code that is in development, official releases are tagged and posted to [pypi](https://pypi.python.org/pypi/pyvmomi/).
Installing
==========
The master is code that is in development, official releases are tagged and posted to [pypi](https://pypi.python.org/pypi/pyvmomi/).

* The official release is availabe using pip, just run `pip install pyvmomi`.
* To install the version in [github](https://github.com/vmware/pyvmomi) use `python setup.py develop` for development install or `python setup.py install`.

Contributing
============
* Research [open issues](https://github.com/vmware/pyvmomi/issues?q=is%3Aopen+is%3Aissue)
* Follow the [contribution standards](https://github.com/vmware/pyvmomi/wiki/Contributions)
* Coordinate with [other developers](http://webchat.freenode.net/?channels=#pyvmomi,#pyvmomi-dev) on the project.

Other Languages
===============
There are other bindings of this API in other languages. See:

* **vijava** (Java): http://vijava.sourceforge.net/
* **rbvmomi** (Ruby): https://github.com/vmware/rbvmomi
* **vSphere SDK for Perl** (non-free): https://my.vmware.com/group/vmware/details?downloadGroup=VSP510-SDKPERL-510&productId=285

Documentation
=============
For general language neutral documentation of vSphere Management API see:
http://pubs.vmware.com/vsphere-55/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html

Python Support
==============
* pyVmomi 5.5.0_2014.1 and above supports Python 2.6, 2.7, 3.3 and 3.4
* pyVmomi 5.5.0_2014.1 (first 2014 release) and above supports Python 2.6, 2.7, 3.3 and 3.4
* pyVmomi 5.5.0 and below supports Python 2.6 and 2.7

Releases
Expand Down

0 comments on commit b306002

Please sign in to comment.