Cookbook

Practical, real-world examples and recipes for packaging applications with FlavorPack.

What's in the Cookbook?

The cookbook contains two types of content:

📚 Examples

Complete, working examples of packaging different types of applications. Each example includes full source code, configuration, and step-by-step instructions.

🧪 Recipes

Short, focused how-to guides for specific integration scenarios and workflows.

Examples

CLI Tools

Package command-line applications and utilities.

CLI Tools Example →

Learn how to package: - Click-based CLI tools - Argument parsing - Multi-command applications - Distribution and installation

Web Applications

Package FastAPI, Flask, and other web applications.

Web Applications Example →

Learn how to package: - FastAPI APIs - Flask web apps - Static file handling - Production deployment

Recipes

Docker Integration

Use FlavorPack packages in Docker containers.

Docker Integration Recipe →

Learn about: - Minimal Docker images - Multi-stage builds - Volume mounts - Docker Compose

CI/CD Pipelines

Automate packaging in CI/CD.

CI/CD Pipelines Recipe →

Learn about: - GitHub Actions - GitLab CI - CircleCI - Artifact management

Quick Navigation

By Application Type

• CLI Tools → CLI Example
• Web APIs → Web App Example
• Terraform Providers → Pyvider Integration

By Integration

• Docker → Docker Recipe
• CI/CD → CI/CD Recipe
• wrknv → wrknv Integration

By Use Case

• Development → Testing Guide
• Production → Docker Recipe
• Distribution → CI/CD Recipe

Contributing Examples

Have a great example or recipe? We'd love to include it!

1. Create your example with complete code
2. Test it thoroughly
3. Submit a pull request
4. Include clear documentation

See Contributing Guide for details.

Example Template

Each example follows this structure:

# Example Title

## Overview
What this example demonstrates

## Prerequisites
What you need before starting

## Step 1: Create Application
Source code for the application

## Step 2: Configure Packaging
Manifest and configuration files

## Step 3: Build Package
Build commands and output

## Step 4: Test & Deploy
Testing and deployment steps

## Troubleshooting
Common issues and solutions

## Next Steps
Related examples and topics

Need Help?

• 📖 Check the User Guide
• 🔍 Search the documentation
• 💬 Ask in Community Support
• 🐛 Report issues on GitHub

---

Ready to start? Try the CLI Tools Example or Web Applications Example.