Skip to content
This repository has been archived by the owner on Jun 13, 2024. It is now read-only.

Latest commit

 

History

History
73 lines (46 loc) · 3.41 KB

README.md

File metadata and controls

73 lines (46 loc) · 3.41 KB
Raw

botocross

A Python package for operating cross region Amazon Web Services (AWS) resources.

Status

Lifecycle: sunset Support: unsupported Maintenance: passive

This project is being sunsetted and is no longer supported.

  • the project's goals have been mostly obsoleted by the excellent AWS Command Line Interface (AWS CLI) - remaining unique functionality should probably be implemented as an AWS CLI plugin, see botocross/issues/44 for details
  • if you should choose to fork it, please let us know so we can link to your project

Introduction

Botocross is a Python package extending the excellent boto with functionality for operating cross region AWS resources - currently it is comprised of:

  • a module structured similar to boto, adding cross region functionality on top of boto's API (very early stages, most of this is still provided inline in the scripts and needs to be refactored into the respective sub modules still)
  • a set of Python scripts for orchestrating cross region AWS resources, i.e. a partial replacement for some AWS command line tools, specifically adding cross region functionality

Origin

The functionality originated in the Amazon EC2 clock accuracy research project and has been extracted due to being of general use in various contexts.

Status

The package is actively used in the Amazon EC2 clock accuracy research as well as a few other internal projects, but still in it's early stages and mainly demand driven - therefore the AWS API coverage is incomplete and likely also inconsistent here and there.

Requirements

The scripts are based on Python 2.7 and have the following dependencies (handled automatically if installed via pip, see below):

  • A recent version of boto (tested against 2.15.0), which provides the interface to Amazon Web Services

Installation

Install via pip from PyPI:

NOTE: botocross is not yet published to PyPI, please use Install from GitHub or Install from source below).

$ pip install botocross

Install via pip from GitHub:

$ pip install git+https://github.com/sopel/botocross.git

Install from source:

$ git clone git://github.com/sopel/botocross.git
$ cd botocross
$ python setup.py install

Usage

The scripts provide common command line argument parsing and help functionality (invoke with no arguments, --help or -h).

AWS credentials are obviously required, which can provided via the command line as well, but are more easily served via environment variables or a configuration file for day to day usage, see section Getting Started with Boto for details.

  • The validate-credentials script provides a convenience method to both validate the AWS credentials and display respective account/user information, which helps when juggling multiple AWS accounts.

License

Licensed under the MIT License (MIT), see LICENSE for details.