aws-cdk-python-setup

Par github · awesome-copilot

Guide de configuration et d'initialisation pour développer des applications AWS CDK (Cloud Development Kit) en Python. Cette skill permet aux utilisateurs de configurer les prérequis d'environnement, créer de nouveaux projets CDK, gérer les dépendances et déployer sur AWS.

npx skills add https://github.com/github/awesome-copilot --skill aws-cdk-python-setup

Configuration AWS CDK Python

Cette skill fournit des conseils de configuration pour travailler avec des projets AWS CDK (Cloud Development Kit) utilisant Python.


Prérequis

Avant de commencer, assurez-vous que les outils suivants sont installés :

  • Node.js ≥ 14.15.0 — Requis pour AWS CDK CLI
  • Python ≥ 3.7 — Utilisé pour écrire le code CDK
  • AWS CLI — Gère les credentials et les ressources
  • Git — Contrôle de version et gestion de projet

Étapes d'installation

1. Installer AWS CDK CLI

npm install -g aws-cdk
cdk --version

2. Configurer les credentials AWS

# Installer AWS CLI (si non installé)
brew install awscli

# Configurer les credentials
aws configure

Entrez votre AWS Access Key, Secret Access Key, région par défaut et format de sortie lorsque vous y êtes invité.

3. Créer un nouveau projet CDK

mkdir my-cdk-project
cd my-cdk-project
cdk init app --language python

Votre projet comprendra :

  • app.py — Point d'entrée principal de l'application
  • my_cdk_project/ — Définitions des stacks CDK
  • requirements.txt — Dépendances Python
  • cdk.json — Fichier de configuration

4. Configurer l'environnement virtuel Python

# macOS/Linux
source .venv/bin/activate

# Windows
.venv\Scripts\activate

5. Installer les dépendances Python

pip install -r requirements.txt

Dépendances principales :

  • aws-cdk-lib — Constructs CDK de base
  • constructs — Bibliothèque de base des constructs

Flux de travail de développement

Synthétiser les templates CloudFormation

cdk synth

Génère cdk.out/ contenant les templates CloudFormation.

Déployer les stacks sur AWS

cdk deploy

Examine et confirme le déploiement sur le compte AWS configuré.

Bootstrap (Premier déploiement uniquement)

cdk bootstrap

Prépare les ressources de l'environnement comme les buckets S3 pour le stockage des assets.


Bonnes pratiques

  • Activez toujours l'environnement virtuel avant de travailler.
  • Exécutez cdk diff avant le déploiement pour prévisualiser les changements.
  • Utilisez les comptes de développement pour les tests.
  • Suivez les conventions de nommage et de répertoires pythoniques.
  • Maintenez requirements.txt verrouillé pour des builds cohérentes.

Conseils de dépannage

Si des problèmes surviennent, vérifiez :

  • Les credentials AWS sont correctement configurés.
  • La région par défaut est définie correctement.
  • Les versions de Node.js et Python respectent les exigences minimales.
  • Exécutez cdk doctor pour diagnostiquer les problèmes d'environnement.

Skills similaires