Merge pull request #102 from hartsock/master
Update README.md - pre-release notes
This commit is contained in:
23
README.md
23
README.md
@@ -1,26 +1,43 @@
|
|||||||
[](https://travis-ci.org/vmware/pyvmomi)
|
[](https://travis-ci.org/vmware/pyvmomi)
|
||||||
[](https://pypi.python.org/pypi/pyvmomi/)
|
[](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/
|
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)
|
* 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:
|
There are other bindings of this API in other languages. See:
|
||||||
|
|
||||||
* **vijava** (Java): http://vijava.sourceforge.net/
|
* **vijava** (Java): http://vijava.sourceforge.net/
|
||||||
* **rbvmomi** (Ruby): https://github.com/vmware/rbvmomi
|
* **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
|
* **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:
|
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
|
http://pubs.vmware.com/vsphere-55/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html
|
||||||
|
|
||||||
Python Support
|
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
|
* pyVmomi 5.5.0 and below supports Python 2.6 and 2.7
|
||||||
|
|
||||||
Releases
|
Releases
|
||||||
|
Reference in New Issue
Block a user