https://github.com/ollionorg/cloudendure-python

A Python 3.7+ client and utilities for CloudEndure
https://github.com/ollionorg/cloudendure-python

api-client aws boto3 cli cloud cloud-migration cloudendure cloudendure-python migrations poetry pypi python python-3 python3 python3-7 python3-8 python3-9 python37 python38 python39

Last synced: 14 days ago
JSON representation

A Python 3.7+ client and utilities for CloudEndure

• Host: GitHub
• URL: https://github.com/ollionorg/cloudendure-python
• Owner: ollionorg
• License: mit
• Created: 2019-05-30T13:12:30.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-10T00:36:17.000Z (over 2 years ago)
• Last Synced: 2024-10-13T09:41:24.970Z (about 1 month ago)
• Topics: api-client, aws, boto3, cli, cloud, cloud-migration, cloudendure, cloudendure-python, migrations, poetry, pypi, python, python-3, python3, python3-7, python3-8, python3-9, python37, python38, python39
• Language: Python
• Homepage: https://2ndWatch.github.io/cloudendure-python/
• Size: 3.2 MB
• Stars: 11
• Watchers: 19
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# cloudendure-python

Python wrapper and CLI for [CloudEndure](https://www.cloudendure.com/)

[![PyPI](https://img.shields.io/pypi/v/cloudendure) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cloudendure)](https://pypi.org/project/cloudendure/) [![PyPi Publish](https://github.com/2ndWatch/cloudendure-python/workflows/PyPi%20Publish/badge.svg)](https://2ndwatch.github.io/cloudendure-python/) [![Documenation](https://github.com/2ndWatch/cloudendure-python/workflows/Github%20Pages/badge.svg)](https://2ndwatch.github.io/cloudendure-python/)

## Requirements

[Python 3.7+](https://www.python.org/downloads/)

## Installation & Usage

### Basic Installation / pip

```sh

pip install cloudendure

cloudendure version

```

### Local Development with Poetry

```sh

brew install poetry # if not installed

poetry install

```

### Local Development with Docker

```sh

docker run --rm -it cloudendurepy/cloudendure bash

```

### Usage

Then import the package:

```python

import cloudendure

```

## Getting Started

CloudEndure Pipeline Flow

![CloudEndure Pipeline Flow](images/ce_migration_pipeline.png)

CloudEndure Data Flow

![CloudEndure Data Flow](images/ce_dataflow.png)

Pipeline Flow (as seen in AWS Console)

![Pipeline_Flow](images/stepfunctions_graph.svg)

### Logging in via CLI using environment variables

Please note: `cloudendure` and `ce` can be used interchangeably

```sh

export CLOUDENDURE_USERNAME=

export CLOUDENDURE_PASSWORD=

export CLOUDENDURE_DESTINATION_ACCOUNT=

cloudendure api login

```

or

```sh

export CLOUDENDURE_USER_API_TOKEN=

export CLOUDENDURE_DESTINATION_ACCOUNT=

ce api login

```

### Logging in via CLI inline

Please note: `cloudendure` and `ce` can be used interchangeably

```sh

cloudendure api login --user= --password=

```

or

```sh

ce api login --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](CHANGELOG.md)