User Guide¶

Welcome to the FlavorPack User Guide. This comprehensive guide covers everything you need to know about using FlavorPack to package and distribute Python applications.

What's in This Guide¶

Core Concepts¶

Understand the fundamentals of FlavorPack and the PSPF format.

PSPF Format - Progressive Secure Package Format specification
Package Structure - How packages are organized
Work Environments - Caching and extraction model
Security Model - Cryptographic signing and verification

Building Packages¶

Learn how to package your applications.

Python Applications - Package Python apps and CLIs
Manifest Files - Configure packaging with manifests
Configuration - Advanced configuration options
Signing Packages - Cryptographically sign packages
Platform Support - Cross-platform packaging

Using Packages¶

Execute and manage packaged applications.

Running Packages - Execute .psp files
CLI Reference - Command-line interface
Inspecting Packages - View package contents
Cache Management - Manage work environment cache
Environment Variables - Configure runtime environment

Advanced Topics¶

Deep dive into advanced features and customization.

Cross-Language Support - Go and Rust integration
Custom Launchers - Build custom launchers
Custom Builders - Extend the build system
Performance Tuning - Optimize package size and speed
Debugging - Troubleshoot issues

Looking for something specific?

First time? → Start with Getting Started
Need examples? → Check out the Cookbook
Having issues? → See Troubleshooting
Contributing? → Read Development Guide

Documentation Structure¶

graph TB
    START[User Guide]

    START --> CONCEPTS[Core Concepts<br/>Fundamentals]
    START --> BUILD[Building Packages<br/>Create .psp files]
    START --> USE[Using Packages<br/>Run & manage]
    START --> ADV[Advanced Topics<br/>Deep dive]

    CONCEPTS --> PSPF[PSPF Format]
    CONCEPTS --> STRUCT[Package Structure]
    CONCEPTS --> WORK[Work Environments]
    CONCEPTS --> SEC[Security]

    BUILD --> PY[Python Apps]
    BUILD --> CONF[Configuration]
    BUILD --> SIGN[Signing]

    USE --> RUN[Running]
    USE --> CLI[CLI Reference]
    USE --> CACHE[Cache Management]

    ADV --> XPLAT[Cross-Language]
    ADV --> PERF[Performance]
    ADV --> DEBUG[Debugging]

    classDef section fill:#e1f5fe,stroke:#01579b
    classDef topic fill:#f3e5f5,stroke:#4a148c

    class START section
    class CONCEPTS,BUILD,USE,ADV topic

Getting Help¶

If you can't find what you're looking for:

📖 Check the Cookbook for practical examples
📚 Review the Glossary for term definitions
🔍 Search the documentation (Ctrl+K or Cmd+K)
💬 Ask in Community Support
🐛 Report issues on GitHub

Ready to start? Jump to Core Concepts or try the Quick Start.