Skip to content

Commit 6234051

Browse files
author
ddraganov
committed
Update README
1 parent 6b0c02a commit 6234051

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

README.rst

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,21 @@ ESX, ESXi, and vCenter.
1111

1212
Getting Started
1313
================
14-
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>`_.
15-
16-
* http://vmware.github.io/pyvmomi-community-samples/
17-
* community discussion on IRC freenode.net channels `#pyvmomi and #pyvmomi-dev <http://webchat.freenode.net/?channels=#pyvmomi,#pyvmomi-dev>`_
18-
* community email is on `nabble <http://pyvmomi.2338814.n4.nabble.com>`_
19-
20-
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.
14+
To get started, see the
15+
`getting started guide <http://vmware.github.io/pyvmomi-community-samples/#getting-started>`_.
16+
You'll need `Python <https://www.python.org/downloads/>`_,
17+
`pip <https://pip.pypa.io/en/latest/installation/>`_, and the
18+
`samples project <http://vmware.github.io/pyvmomi-community-samples/>`_.
2119

2220
Installing
2321
==========
24-
The master is code that is in development, official releases are tagged and
22+
The master is code that is in development, official releases are tagged and
2523
posted to `pypi <https://pypi.python.org/pypi/pyvmomi/>`_
2624

27-
* The official release is available using pip, just run
28-
``pip install --upgrade pyvmomi``.
29-
* To install the version in `github <https://github.com/vmware/pyvmomi>`_ use
30-
``python setup.py develop`` for development install or
25+
* The official release is available using pip, just run
26+
``pip install --upgrade pyvmomi``.
27+
* To install the version in `github <https://github.com/vmware/pyvmomi>`_ use
28+
``python setup.py develop`` for development install or
3129
``python setup.py install``.
3230
* To install `github's version <https://github.com/vmware/pyvmomi>`_ with sso support, just run
3331
``pip install -e .[sso]`` inside project's home folder.
@@ -44,26 +42,33 @@ Contributing
4442
============
4543
* Research `open issues <https://github.com/vmware/pyvmomi/issues?q=is%3Aopen+is%3Aissue>`_
4644
* Follow the `contribution standards <https://github.com/vmware/pyvmomi/wiki/Contributions>`_
47-
* Coordinate with `other developers <http://webchat.freenode.net/?channels=#pyvmomi,#pyvmomi-dev>`_ on the project.
4845

4946
Documentation
5047
=============
51-
For general language neutral documentation of vSphere Management API see:
48+
For general language neutral documentation of vSphere Management API see:
5249

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

5552
Python Support
5653
==============
57-
* pyVmomi supports 2.7.x and 3.4+
54+
* pyVmomi supports Python 3.4+
55+
56+
Versioning
57+
====================
58+
pyVmomi: **X.Y.Z.U.P**
59+
60+
vCenter-related:
61+
**X.Y** - (Major release), **Z** - (Update release), **U** - (Patch)
5862

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

6166
Compatibility Policy
6267
====================
63-
pyVmomi versions are marked vSphere_version-release . Pyvmomi maintains minimum
64-
backward compatibility with the previous _four_ releases of *vSphere* and it's
65-
own previous four releases. Compatibility with much older versions may continue
66-
to work but will not be actively supported.
68+
pyVmomi maintains minimum backward compatibility with the previous
69+
*four* releases of *vSphere* and it's own previous four releases.
70+
Compatibility with much older versions may continue to work but will
71+
not be actively supported.
6772

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

0 commit comments

Comments
 (0)