Skip to content

Commit

Permalink
Fix README to be pypi legible
Browse files Browse the repository at this point in the history
A pypi friendly version of the readme documentation.

closes: vmware#134
  • Loading branch information
hartsock committed Aug 26, 2014
1 parent dd49048 commit be59d9c
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 68 deletions.
66 changes: 0 additions & 66 deletions README.md

This file was deleted.

78 changes: 78 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
.. image:: https://travis-ci.org/vmware/pyvmomi.svg?branch=v5.5.0_2014.1
:target: https://travis-ci.org/vmware/pyvmomi
:alt: Build Status

.. image:: https://pypip.in/download/pyvmomi/badge.png
:target: https://pypi.python.org/pypi/pyvmomi/
:alt: Downloads

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>`_

* community email is on `nabble <http://pyvmomi.2338814.n4.nabble.com>`_

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 --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``.

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:

* `vSphere WS SDK API Docs <http://pubs.vmware.com/vsphere-55/topic/com.vmware.wssdk.apiref.doc/right-pane.html>`_

Python Support
==============
* pyVmomi 5.5.0-2014.1 and later support Python 2.6, 2.7, 3.3 and 3.4
* pyVmomi 5.5.0 and below support Python 2.6 and 2.7

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.

For example, version v5.5.0-2014.1 is most compatible with vSphere 5.5, 5.1,
5.0, and 4.1 and was the first release in 2014. Initial releases compatible with
a version of vSphere will bare a naked version number of v5.5.0 indicating that
version of pyVmomi was released simultaneously with the *GA* version of vSphere
with the same version number.

Releases
========
* `5.5.0-2014.1.1 <https://github.com/vmware/pyvmomi/tree/v5.5.0-2014.1.1>`_
release notes https://github.com/vmware/pyvmomi/releases/tag/v5.5.0-2014.1.1
* `5.5.0-2014.1 <https://github.com/vmware/pyvmomi/tree/v5.5.0-2014.1>`_
release notes https://github.com/vmware/pyvmomi/releases/tag/v5.5.0-2014.1
* `5.5.0 <https://github.com/vmware/pyvmomi/tree/v5.5.0>`_
* `5.1.0 <https://github.com/vmware/pyvmomi/tree/v5.1.0>`_
release notes https://github.com/vmware/pyvmomi/releases/tag/v5.1.0

Related Projects
================
* Feature Incubator: pyvmomi-tools https://github.com/vmware/pyvmomi-tools
* Samples Project: https://github.com/vmware/pyvmomi-community-samples

Have fun!
13 changes: 11 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,25 @@ def read(fname):
packages=['pyVmomi', 'pyVim'],
install_requires=required,
license='License :: OSI Approved :: Apache Software License',
long_description=read('README.md'),
# NOTE: pypi prefers the use of RST to render docs
long_description=read('README.rst'),
classifiers=[
"License :: OSI Approved :: Apache Software License",
"Development Status :: 5 - Production/Stable",
"Environment :: No Input/Output (Daemon)",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Intended Audience :: Information Technology",
"Intended Audience :: System Administrators",
"Intended Audience :: Developers",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: System :: Distributed Computing"
"Topic :: System :: Distributed Computing",
"Operating System :: Microsoft :: Windows",
"Operating System :: POSIX",
"Operating System :: Unix",
"Operating System :: MacOS",
],
platforms = ["Windows", "Linux", "Solaris", "Mac OS-X", "Unix"],
test_suite='tests',
tests_require= required_for_tests,
zip_safe=True
Expand Down

0 comments on commit be59d9c

Please sign in to comment.