Installation
Install with CLI
Recommended
gh skills-hub install aws-cdk-python-setup Don't have the extension? Run gh extension install samueltauil/skills-hub first.
Download and extract to your repository:
.github/skills/aws-cdk-python-setup/ Extract the ZIP to .github/skills/ in your repo. The folder name must match aws-cdk-python-setup for Copilot to auto-discover it.
Skill Files (1)
SKILL.md 2.5 KB
---
name: aws-cdk-python-setup
description: Setup and initialization guide for developing AWS CDK (Cloud Development Kit) applications in Python. This skill enables users to configure environment prerequisites, create new CDK projects, manage dependencies, and deploy to AWS.
---
# AWS CDK Python Setup Instructions
This skill provides setup guidance for working with **AWS CDK (Cloud Development Kit)** projects using **Python**.
---
## Prerequisites
Before starting, ensure the following tools are installed:
- **Node.js** โฅ 14.15.0 โ Required for the AWS CDK CLI
- **Python** โฅ 3.7 โ Used for writing CDK code
- **AWS CLI** โ Manages credentials and resources
- **Git** โ Version control and project management
---
## Installation Steps
### 1. Install AWS CDK CLI
```bash
npm install -g aws-cdk
cdk --version
```
### 2. Configure AWS Credentials
```bash
# Install AWS CLI (if not installed)
brew install awscli
# Configure credentials
aws configure
```
Enter your AWS Access Key, Secret Access Key, default region, and output format when prompted.
### 3. Create a New CDK Project
```bash
mkdir my-cdk-project
cd my-cdk-project
cdk init app --language python
```
Your project will include:
- `app.py` โ Main application entry point
- `my_cdk_project/` โ CDK stack definitions
- `requirements.txt` โ Python dependencies
- `cdk.json` โ Configuration file
### 4. Set Up Python Virtual Environment
```bash
# macOS/Linux
source .venv/bin/activate
# Windows
.venv\Scripts\activate
```
### 5. Install Python Dependencies
```bash
pip install -r requirements.txt
```
Primary dependencies:
- `aws-cdk-lib` โ Core CDK constructs
- `constructs` โ Base construct library
---
## Development Workflow
### Synthesize CloudFormation Templates
```bash
cdk synth
```
Generates `cdk.out/` containing CloudFormation templates.
### Deploy Stacks to AWS
```bash
cdk deploy
```
Reviews and confirms deployment to the configured AWS account.
### Bootstrap (First Deployment Only)
```bash
cdk bootstrap
```
Prepares environment resources like S3 buckets for asset storage.
---
## Best Practices
- Always activate the virtual environment before working.
- Run `cdk diff` before deployment to preview changes.
- Use development accounts for testing.
- Follow Pythonic naming and directory conventions.
- Keep `requirements.txt` pinned for consistent builds.
---
## Troubleshooting Tips
If issues occur, check:
- AWS credentials are correctly configured.
- Default region is set properly.
- Node.js and Python versions meet minimum requirements.
- Run `cdk doctor` to diagnose environment issues.
License (MIT)
View full license text
MIT License Copyright GitHub, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.