Skip to content

wyattowalsh/macaron

Repository files navigation

macaron project banner

🍪 macaron

A cookiecutter bundle of the best Python project resources

License: GPL-3.0 Documentation GitHub Issues

🚀 Quick Start

Make sure you have pipx installed, then run:

pipx install cookiecutter
pipx run cookiecutter gh:wyattowalsh/macaron

🛠️ Development Environment Setup

The project includes a comprehensive environment setup script (setup_env.sh) that configures a complete development environment.

Features

  • Flexible configuration via command line arguments, environment variables, config files
  • Parallel component installation with dependency resolution
  • Smart version detection and management
  • Automatic retry mechanism for failed installations
  • Progress tracking with resume capability
  • Atomic shell configuration management
  • Cross-platform package management
  • Comprehensive logging and debugging support
  • CI/CD optimized with automated mode
  • Cross-platform support (Linux, macOS)

Usage

Basic setup:

./scripts/setup_env.sh

Options:

  • -h, --help: Show help message
  • -v, --version: Show script version
  • -s, --skip-checks: Skip system requirement checks
  • -d, --debug: Enable debug mode
  • -r, --resume: Resume from last successful step

Configuration

The setup script can be configured through multiple methods (in order of precedence):

  1. Command line arguments
  2. Environment variables
  3. Configuration file (.setupenv.conf)
  4. Project files (cookiecutter.json, pyproject.toml)
  5. Default values

📚 Documentation

For complete documentation, please visit macaron.w4w.dev