https://github.com/neilkuan/cdk-python-tips

https://github.com/neilkuan/cdk-python-tips

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/neilkuan/cdk-python-tips
• Owner: neilkuan
• Created: 2021-08-04T11:42:20.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-04T11:42:48.000Z (over 3 years ago)
• Last Synced: 2024-10-06T10:11:20.077Z (about 1 month ago)
• Language: Python
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Welcome to your CDK Python project!

This is a blank project for Python development with CDK.

The `cdk.json` file tells the CDK Toolkit how to execute your app.

This project is set up like a standard Python project.  The initialization

process also creates a virtualenv within this project, stored under the `.venv`

directory.  To create the virtualenv it assumes that there is a `python3`

(or `python` for Windows) executable in your path with access to the `venv`

package. If for any reason the automatic creation of the virtualenv fails,

you can create the virtualenv manually.

To manually create a virtualenv on MacOS and Linux:

```

$ python3 -m venv .venv

```

After the init process completes and the virtualenv is created, you can use the following

step to activate your virtualenv.

```

$ source .venv/bin/activate

```

If you are a Windows platform, you would activate the virtualenv like this:

```

% .venv\Scripts\activate.bat

```

Once the virtualenv is activated, you can install the required dependencies.

```

$ pip install -r requirements.txt

```

At this point you can now synthesize the CloudFormation template for this code.

```

$ cdk synth

```

To add additional dependencies, for example other CDK libraries, just add

them to your `setup.py` file and rerun the `pip install -r requirements.txt`

command.

## Useful commands

 * `cdk ls`          list all stacks in the app

 * `cdk synth`       emits the synthesized CloudFormation template

 * `cdk deploy`      deploy this stack to your default AWS account/region

 * `cdk diff`        compare deployed stack with current state

 * `cdk docs`        open CDK documentation

Enjoy!

# cdk-python-tips