Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ddraganov committed Dec 15, 2022
1 parent 6b0c02a commit 6234051
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,21 @@ ESX, ESXi, and vCenter.

Getting Started
================
To get started, see the `getting started guide <http://vmware.github.io/pyvmomi-community-samples/#getting-started>`_. You'll need `Python <https://www.python.org/downloads/>`_, `pip <https://pip.pypa.io/en/latest/installing.html#using-package-managers>`_, and the `samples project <https://github.com/vmware/pyvmomi-community-samples/tarball/master>`_.

* 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 email is on `nabble <http://pyvmomi.2338814.n4.nabble.com>`_

Don't know what pip is? Any serious python developer should know, so here's a `throrough intro to pip <http://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/>`_ that we like.
To get started, see the
`getting started guide <http://vmware.github.io/pyvmomi-community-samples/#getting-started>`_.
You'll need `Python <https://www.python.org/downloads/>`_,
`pip <https://pip.pypa.io/en/latest/installation/>`_, and the
`samples project <http://vmware.github.io/pyvmomi-community-samples/>`_.

Installing
==========
The master is code that is in development, official releases are tagged and
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 available using pip, just run
``pip install --upgrade pyvmomi``.
* To install the version in `github <https://github.com/vmware/pyvmomi>`_ use
``python setup.py develop`` for development install or
* The official release is available using pip, just run
``pip install --upgrade 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``.
* To install `github's version <https://github.com/vmware/pyvmomi>`_ with sso support, just run
``pip install -e .[sso]`` inside project's home folder.
Expand All @@ -44,26 +42,33 @@ 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.

Documentation
=============
For general language neutral documentation of vSphere Management API see:
For general language neutral documentation of vSphere Management API see:

* `vSphere WS SDK API Docs <https://code.vmware.com/apis/968/vsphere>`_

Python Support
==============
* pyVmomi supports 2.7.x and 3.4+
* pyVmomi supports Python 3.4+

Versioning
====================
pyVmomi: **X.Y.Z.U.P**

vCenter-related:
**X.Y** - (Major release), **Z** - (Update release), **U** - (Patch)

Note: python2 is deprecated from 01/2020 https://www.python.org/doc/sunset-python-2/. Please switch to Python3
pyVmomi-related:
**P** - (pyVmomi patches)

Compatibility Policy
====================
pyVmomi versions are marked vSphere_version-release . Pyvmomi maintains minimum
backward compatibility with the previous _four_ releases of *vSphere* and it's
own previous four releases. Compatibility with much older versions may continue
to work but will not be actively supported.
pyVmomi maintains minimum backward compatibility with the previous
*four* releases of *vSphere* and it's own previous four releases.
Compatibility with much older versions may continue to work but will
not be actively supported.

For example, version v6.0.0 is most compatible with vSphere 6.0, 5.5, 5.1 and
5.0. Initial releases compatible with a version of vSphere will bare a naked
Expand Down

0 comments on commit 6234051

Please sign in to comment.