README.md

cloudendure-python

Python wrapper and CLI for CloudEndure

Requirements

Python 3.7+

Installation & Usage

Basic Installation / pip

pip install cloudendure
cloudendure version

Local Development with Poetry

brew install poetry # if not installed
poetry install

Local Development with Docker

docker run --rm -it cloudendurepy/cloudendure bash

Usage

Then import the package:

import cloudendure

Getting Started

CloudEndure Pipeline Flow

CloudEndure Data Flow

Pipeline Flow (as seen in AWS Console)

Logging in via CLI using environment variables

Please note: cloudendure and ce can be used interchangeably

export CLOUDENDURE_USERNAME=<your_ce_user>
export CLOUDENDURE_PASSWORD=<your_ce_password>
export CLOUDENDURE_DESTINATION_ACCOUNT=<destination_aws_account_id>

cloudendure api login

or

export CLOUDENDURE_USER_API_TOKEN=<your_ce_user_api_token>
export CLOUDENDURE_DESTINATION_ACCOUNT=<destination_aws_account_id>

ce api login

Logging in via CLI inline

Please note: cloudendure and ce can be used interchangeably

cloudendure api login --user=<your_ce_user> --password=<your_ce_password>

or

ce api login --token=<your_ce_user_api_token>

Logging in for the first time will generate the ~/.cloudendure.yml file.

Coming Soon

This project is currently a work in progress and will actively change. This client has not yet been finalized and is entirely subject to change.

Changelog

Check out the CHANGELOG