Skip to content
This repository was archived by the owner on Mar 15, 2021. It is now read-only.

Commit

Permalink
Updated README.md with image, setup, spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
codyde committed May 24, 2019
1 parent 288bd9a commit 00e2d79
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 22 deletions.
Binary file added DeploymentListDemo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 23 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,57 @@
# Cloud Automation Services SDK for Python (Caspyr)
This is a set of Python (3.6 minimum version) bindings for VMware's Cloud Automation Services (Cloud Assembvly, Service Broker, Code Stream) meant to simplify programmtic consumption of it's API interfaces.

The initial usecase was designed to automate the 1902-03 Hands On Labs for VMworld; but significant usecase exist to consume this SDK.
This is a set of Python (3.6 minimum version) bindings for VMware Cloud Automation Services (Cloud Assembly, Service Broker, Code Stream) meant to simplify programmatic consumption of it's API interfaces.

This kit was primarilly designed by VMware employees however is not a VMware project as of now.
![](DeploymentListDemo.gif)

## Requirements for Usage
* Python 3.6
* This Repository
The initial use case was designed to automate the 1902-03 Hands On Labs for VMworld; but significant use case exist to consume this SDK.

This kit was primarily designed by VMware employees however is not a VMware project as of now.

## Requirements for Usage

* Python 3.6
* This Repository
* API Key with sufficient permissions to the Cloud Automation Services platform

## Getting Started
## Getting Started

Clone this repository and access a Python Shell. Import the appropriate modules/libraries in order to begin interacting with the platform. Example import statement is below
Clone this repository and install leveraging the setup.py file.

```bash
python setup.py install
```

Once installation is complete, Import the appropriate modules/libraries in order to begin interacting with the platform. Example import statement is below

```python
from caspyr import Session, User, Region
from caspyr import CloudAccountAws, CloudAccountAzure, CloudAccount
from caspyr import CloudZone, ImageMapping, FlavorMapping
from caspyr import NetworkProfile, StorageProfileAWS, StorageProfileAzure, StorageProfile
from caspyr import Project, Request, Deployment, Blueprint, Machine
```

From here, we will authenticate to the Cloud Services Platform by establishing an object for we can interact with.
From here, we will authenticate to the Cloud Services Platform by establishing an object for we can interact with.

```
```python
s = Session.login(api_token)
```

With this object instantiated, we can leverage other calls, passing the session object in to return data. Examples can be found in the examples directory.
With this object instantiated, we can leverage other calls, passing the session object in to return data. Examples can be found in the examples directory.

### Listing all Current Deployments

```
```python
s = Session.login(api_token)
d = Deployment.list(s)
```

### Listing all Projects

```
s = Session.login(api_token)
p = Projects.list(s)
```

### Import Blueprint from Github Repository

```
```python
s = Session.login(api_token)
p = Projects.list(s)
projID = p[0]['id']
b = Blueprint.create(s,projID,'Sample BP','Sample Blueprint Name','1','codyde/cas-blueprints','samplebp.yaml')
```

Documentation is forthcoming (PR's welcome!)
Expand Down

0 comments on commit 00e2d79

Please sign in to comment.