Installation

Python Version

CoWorks supports only AWS Lambda python version >= 3.7.

Install Coworks

Use a virtual environment to install CoWorks. We recommend using pipenv:

$ mkdir project && cd "$_"
$ touch Pipfile
$ pipenv install coworks
$ pipenv shell

You can then verify the installation by running:

(project) $ cws --version

CoWorks is now ready for use.

Create a project

To create a new project, enter:

(project) $ cws new
New project created.

You now have everything you need to create your first micro-service by following Tech Quickstart.

Other tools

Note

Please see below sections on AWS and Terraform setup prior to deployment.

Prior to use, please ensure that you also have the AWS CLI and Terrraform binary installed. You can check by running:

$ aws --version
$ terraform --version

AWS Credentials

If you have previously configured your machine to run boto3 (the AWS SDK for Python) or the AWS CLI then you can skip this section.

Before you can deploy an application, make sure you have an AWS account and configured the AWS credentials.

Terraform

If you have previously installed terraform then you can skip this section.

For deployment, for the command deploy we are using terraform. We can use it locally or on online cloud plateform terraform.io.

Follow these instructions to install terraform. Check installation with:

(project) $ terraform --version

Terraform can also be used online.

Apache Airflow

Apache Airflow may be installed manually, or provided by Astronomer or AWS.

In this documentation we will describe how to use CoWorks with AWS MWAA.

From the coworks source code, create the zip plugins file by

$ make plugins.zip

And upload it to S3, then attached this file to the MWAA environment used. Now the coworks operators and sensors are accessible defined in your environment.

More information : Installing custom plugins.