https://github.com/wyattowalsh/macaron
a python cookiecutter project boilerplate using the best tools
https://github.com/wyattowalsh/macaron
cookiecutter cookiecutter-pypackage cookiecutter-python cookiecutter-python3 cookiecutter-template docusaurus fastapi github-actions loguru makefile poetry pyenv rich scss shadcn-ui typer typer-cli
Last synced: 9 days ago
JSON representation
a python cookiecutter project boilerplate using the best tools
- Host: GitHub
- URL: https://github.com/wyattowalsh/macaron
- Owner: wyattowalsh
- License: gpl-3.0
- Created: 2024-09-09T23:13:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-05T08:42:10.000Z (6 months ago)
- Last Synced: 2025-08-05T10:13:32.851Z (6 months ago)
- Topics: cookiecutter, cookiecutter-pypackage, cookiecutter-python, cookiecutter-python3, cookiecutter-template, docusaurus, fastapi, github-actions, loguru, makefile, poetry, pyenv, rich, scss, shadcn-ui, typer, typer-cli
- Language: Python
- Homepage: https://macaron.w4w.dev
- Size: 5.88 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🍪 macaron
A cookiecutter bundle of the best Python project resources
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://w4w.dev/macaron)
[](https://github.com/wyattowalsh/macaron/issues)
## 🚀 Quick Start
Make sure you have [pipx](https://github.com/pypa/pipx) installed, then run:
```bash
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:
```bash
./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](https://macaron.w4w.dev)