Skip to main content

A CLI application that teaches AWS CDK in Python to software engineers.

Project description

CDK Tutor

A CLI application that teaches AWS CDK to users through interactive challenges.

Installation

With pip:

pip install cdk-tutor

With pipx:

pipx install cdk-tutor

With uvx:

uvx install cdk-tutor

Usage

List available challenges

cdk-tutor list-challenges

Start a challenge

cdk-tutor start [CHALLENGE_NAME]

If you don't specify a challenge name, you'll be prompted to choose from available challenges.

Setup a Python virtual environment

python -m venv .venv
source .venv/bin/activate  # On Windows use .venv\Scripts\activate
pip install -r requirements.txt

Grade a completed challenge

cdk-tutor grade [CHALLENGE_DIR]

Features

  • Interactive CLI with rich text formatting
  • Step-by-step challenges to learn AWS CDK
  • Automatic grading of solutions
  • Detailed feedback to help users improve

Challenge Structure

Each challenge includes:

  • Starter code with TODOs to complete
  • Clear instructions in a README
  • Expected CloudFormation output for grading
  • Solution files for reference

Development

To add new challenges:

  1. Create a new challenge in src/cdk_tutor/challenges/
  2. Follow the Challenge model structure
  3. Add your challenge to the list in get_available_challenges()

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk_tutor-0.2.0.tar.gz (48.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cdk_tutor-0.2.0-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file cdk_tutor-0.2.0.tar.gz.

File metadata

  • Download URL: cdk_tutor-0.2.0.tar.gz
  • Upload date:
  • Size: 48.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cdk_tutor-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9f0b23fde3bc04bd4a5725ca2a1fe1b8acd77d75fea3c87507539e99aac98a34
MD5 a6f7cc31a4423422f67499056b3d3604
BLAKE2b-256 0d992c99ab0d42611208a4b0d5d898f803fad955bef0d10669e72ef870005706

See more details on using hashes here.

Provenance

The following attestation bundles were made for cdk_tutor-0.2.0.tar.gz:

Publisher: deploy.yml on amirkarimi/cdk-tutor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cdk_tutor-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: cdk_tutor-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cdk_tutor-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a6236ce7536b289821b8b51fde85954ac1643ffd17089abc2f42ece0d8e475e
MD5 55ff66cfc86e215e6369f5cdee0dd038
BLAKE2b-256 ed22d8bac86efa93d8c93b9244c55507d73acd1ff89dfc31dc774f5a2ee76de0

See more details on using hashes here.

Provenance

The following attestation bundles were made for cdk_tutor-0.2.0-py3-none-any.whl:

Publisher: deploy.yml on amirkarimi/cdk-tutor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page