Metadata-Version: 2.3
Name: runway
Version: 2.8.4
Summary: Simplify infrastructure/app testing/deployment
License: Apache-2.0
Keywords: cli
Author: Rackspace Technology, Inc.
Author-email: opensource@rackspace.com
Maintainer: Kyle Finley
Maintainer-email: kyle@finley.sh
Requires-Python: >=3.9,<4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Utilities
Requires-Dist: awacs
Requires-Dist: boto3 (>=1.34.50,<2.0.0)
Requires-Dist: cfn-lint
Requires-Dist: cfn_flip (>=1.2,<2.0)
Requires-Dist: click (>=8.0,<9.0)
Requires-Dist: coloredlogs (!=15.0.1)
Requires-Dist: docker (>=3.0.0)
Requires-Dist: eval-type-backport ; python_version < "3.10"
Requires-Dist: formic2
Requires-Dist: gitpython
Requires-Dist: igittigitt (>=2.0.5)
Requires-Dist: jinja2 (>=2.7)
Requires-Dist: packaging
Requires-Dist: pyOpenSSL
Requires-Dist: pydantic (>=2.8.0,<3.0.0)
Requires-Dist: pyhcl (>=0.4,<0.5)
Requires-Dist: python-hcl2 (>=3.0.0)
Requires-Dist: pyyaml (>5.4)
Requires-Dist: requests
Requires-Dist: tomli (>=1.2.2)
Requires-Dist: troposphere (>=2.4,<5)
Requires-Dist: typing_extensions
Requires-Dist: yamllint
Project-URL: Bug Tracker, https://github.com/rackspace/runway/issues
Project-URL: Documentation, https://runway.readthedocs.io
Project-URL: Homepage, https://github.com/rackspace/runway
Project-URL: Repository, https://github.com/rackspace/runway
Description-Content-Type: text/markdown

# Runway

[![CI/CD](https://github.com/rackspace/runway/actions/workflows/cicd.yml/badge.svg)](https://github.com/rackspace/runway/actions/workflows/cicd.yml)
[![codecov](https://codecov.io/gh/rackspace/runway/branch/master/graph/badge.svg?token=Ku28I0RY80)](https://codecov.io/gh/rackspace/runway)
[![PyPi](https://img.shields.io/pypi/v/runway?style=flat)](https://pypi.org/project/runway/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/rackspace/runway/master.svg)](https://results.pre-commit.ci/latest/github/rackspace/runway/master)

![runway-example.gif](https://raw.githubusercontent.com/rackspace/runway/master/docs/source/images/runway-example.gif)

Runway is a lightweight integration app designed to ease management of infrastructure tools.

Its main goals are to encourage GitOps best-practices, avoid convoluted Makefiles/scripts (enabling identical deployments from a workstation or CI job), and enable developers/admins to use the best tool for any given job.

## Features

- Centralized environment-specific configuration
- Automatic environment identification from git branches
- Automatic linting/verification
- Support of IAM roles to assume for each deployment
- Terraform backend/workspace config management w/per-environment tfvars
- Automatic kubectl/terraform version management per-environment

### Supported Deployment Tools

- AWS CDK
- Kubectl
- Serverless Framework
- CFNgin (CloudFormation)
- Static websites (build & deploy to S3+CloudFront)
- Terraform

## Example

A typical Runway configuration is unobtrusive -- it just lists the deployment order and locations (regions).

```yml
deployments:
  - modules:
      - resources.tf  # terraform resources
      - backend.sls  # serverless lambda functions
      - frontend  # static web site
    environments:  # Environments
      dev: "123456789012"  # AWS development Account ID
      prod: "234567890123"  # AWS production Account ID
    regions:
      - us-east-1
```

The example above contains enough information for Runway to deploy all resources, lambda functions and a static website backed by S3 and Cloudfront in either dev or prod environments

## Install

```shell
$ pip install runway
$ runway new
# OR
$ poetry add --dev runway
$ poetry run runway new
```

## Documentation

See the [doc site](https://runway.readthedocs.io) for full documentation.

Quickstart documentation, including CloudFormation templates and walkthrough can be found [here](https://runway.readthedocs.io/page/quickstart/index.html)

