Skip to content

Getting Started with provide.foundation

Welcome to provide.foundation! This section will guide you through installation and your first application in just a few minutes.

What is provide.foundation?

provide.foundation is a comprehensive Python library for building robust, production-ready applications with:

  • Structured Logging: Beautiful, performant logging with zero configuration
  • CLI Framework: Build command-line tools with declarative commands
  • Configuration: Environment-based configuration without hardcoded defaults
  • Resilience: Retry patterns, error handling, and failure recovery
  • Utilities: File operations, cryptography, serialization, and more

Quick Navigation

📦 Installation

Install Foundation and configure your environment

Start Here →

⚡ Quick Start

Write your first Foundation application in 5 minutes

Get Coding →

🏗️ First Application

Build a complete CLI task manager

Build Something →

💡 Examples

Explore code examples for all features

See Examples →

Learning Path

We recommend following this path:

  1. Installation - Set up your environment (2 minutes)
  2. Quick Start - Write your first logs (5 minutes)
  3. First Application - Build a CLI tool (15 minutes)
  4. Examples - Explore specific features (ongoing)

After completing these, dive into the How-To Guides for specific use cases.

System Requirements

  • Python 3.11 or higher
  • Works on Linux, macOS, and Windows
  • Minimal core dependencies (structlog, attrs)

Optional Features

Foundation has modular installation options:

Feature Install Command When You Need It
Basic logging pip install provide-foundation Core functionality
CLI framework pip install provide-foundation[cli] Building command-line tools
Cryptography pip install provide-foundation[crypto] Hashing, signing, certificates
HTTP Transport pip install provide-foundation[transport] HTTP client utilities
OpenTelemetry pip install provide-foundation[opentelemetry] Distributed tracing
All features pip install provide-foundation[all] Everything above

Need Help?

Ready to begin? Start with Installation →