Metadata-Version: 2.0
Name: pyvcloud
Version: 18.0.4.dev43
Summary: VMware vCloud Director Python SDK
Home-page: https://github.com/vmware/pyvcloud
Author: Paco Gomez
Author-email: pgomez@vmware.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Requires-Dist: PyYAML (>=3.10)
Requires-Dist: flufl.enum
Requires-Dist: iptools (>=0.6.1)
Requires-Dist: lxml (>=3.4.1)
Requires-Dist: netaddr (>=0.7.13)
Requires-Dist: progressbar (>=2.3)
Requires-Dist: requests (>=2.18.3)

pyvcloud
========

|docs-latest| |ver| |build-status|

Python SDK for VMware vCloud Director and vCloud Air.

This project is under development, the classes, methods and parameters might change over time. This README usually reflects the syntax of the latest version.

New vCD support is located under `pyvcloud/vcd <pyvcloud/vcd>`_ directory.

Sample Usage
============

Import modules and instantiate a VCA object:

.. code:: python

    from pyvcloud.vcloudair import VCA
    vcd = VCA(host, user, service_type, service_version, verify)

Login to a vCloud Director instance:

.. code:: python

    result = vcd.login(password=password, org=org)

See `changes log <ChangeLog>`_ for a list of changes.

Installation
============

The Python SDK requires the libxml2 and libxslt libraries, see `lxml <http://lxml.de/installation.html>`_ for more details.

On Debian/Ubuntu, you can install `lxml` and Python development dependencies with this command:

.. code:: bash

    sudo apt-get install libxml2-dev libxslt-dev python-dev python-pip

On RHEL-based distributions:

.. code:: bash

    sudo yum install libxslt-devel libxml2-devel python-devel python-pip

The Python SDK can then be installed with the following command:

.. code:: bash

    pip install --user pyvcloud

**pyvcloud** can also be installed with `virtualenv <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_

Examples
========

See the `examples <https://github.com/vmware/pyvcloud/blob/master/examples>`_ directory for sample code.

Development and Test
====================

To run the source code, check it out from GitHub and install it with:

.. code:: bash

    python setup.py develop

To log the requests, add the ``log=True`` parameter to the VCA constructor. The log is appended to file ``$TMPDIR/pyvcloud.log``.

.. code:: python

    vcd = VCA(host=host,
              username=username,
              service_type='vcd',
              version='5.7',
              verify=False,
              log=True)

To test **pyvcloud**:

.. code:: bash

    git clone https://github.com/vmware/pyvcloud.git
    cd pyvcloud
    virtualenv .venv
    source .venv/bin/activate
    python setup.py develop
    pip install -r test-requirements.txt
    cp tests/config.yaml my_config.yaml
    # customize credentials and other parameters
    nosetests --verbosity=2  --tc-format yaml --tc-file my_config.yaml tests/00010_vcd_login.py

See `.gitlab-ci.yml <.gitlab-ci.yml>`_ for current tests.

.. |build-status| image:: https://img.shields.io/travis/vmware/pyvcloud.svg?style=flat
    :alt: build status
    :scale: 100%
    :target: https://travis-ci.org/vmware/pyvcloud/

.. |docs-latest| image:: https://readthedocs.org/projects/pyvcloud/badge/?version=latest
    :alt: Documentation Status
    :scale: 100%
    :target: http://pyvcloud.readthedocs.org/en/latest/

.. |ver| image:: https://img.shields.io/pypi/v/pyvcloud.svg
    :alt: Stable Version
    :scale: 100%
    :target: https://pypi.python.org/pypi/pyvcloud



