kegstandcli 0.3.11

The Developer's Toolbelt For Accelerating Mean-Time-To-Party on AWS

The Developer's Toolbelt For Accelerating Mean Time To Party on AWS

Created by Jens Roland and fueled by a non-zero amount of alcohol

Watch a 3-minute demo

🥂💃🕺 Welcome to the Party! 🥂💃🕺

Kegstand is a free and open-source framework for creating Python APIs and services. It allows you to rapidly build and deploy services on AWS. We all have better things to do than print(json.dumps(event)) all day long, and Kegstand is here to help you get to the party — and into Prod — a lot faster.

It provides:

• A CLI tool for creating and deploying your services.
• A decorator based framework abstracting away the boilerplate of AWS Lambda, API Gateway, Cognito, and more.
• The full power of CDK to define and deploy arbitrary AWS resources with your services.

"Experience a streamlined cloud development process, enhanced productivity, and hit that "party" button sooner with Kegstand!" > — GPT-4, official spokesbot for the Kegstand team

Learn more on the Kegstand website.

Prerequisites

• Python 3.12+
• uv or Poetry
• AWS account
• AWS CLI configured with credentials
• AWS CDK CLI configured and initialized
• A well-poured Belgian style brown ale

Quick start

To create a service with Kegstand, you'll need a Python project with a few dependencies and a folder structure following the Kegstand convention.

You can create this in a few seconds, either with the Kegstand CLI or using Copier.

# Using the Kegstand CLI
> uvx install kegstandcli  # Or `pipx install kegstandcli`
> keg new my-service

# Using Copier
> copier copy -d project_name=my-service gh:JensRoland/kegstand-project-template .

Either method will create a new project folder called my-service containing:

📁 my-service
├── 📄 .gitignore                    # Standard .gitignore file
├── 📄 pyproject.toml                # Project configuration
└── 📁 src
    └── 📁 api
        └── 📁 public
            └── 📄 hello.py          # Logic for /hello/

Kegstand projects are minimal by design, so a fresh project folder contains just those 3 files. Well, apart from a few empty __init__.py gatecrashers, but we can safely ignore those.

Install the dependencies for the new project (uv will do this for you during uv run so it's not strictly necessary):

> cd my-service
> uv sync

Finally, to build and deploy the service to AWS:

> uv run keg deploy

Note: Even if you installed the Kegstand CLI globally with uvx or pipx, it is still recommended to use uv run to ensure that you are using the correct CLI version for the specific project.

You should now be able to access the API endpoint at https://<api-id>.execute-api.<region>.amazonaws.com/prod/hello.

Documentation

For further examples and more advanced usage, see the official documentation.