Dotfiles update 2025-12-25 12:04
This commit is contained in:
Aaron D. Lee
@@ -1,173 +1,616 @@
|
||||
# ============================================================================
|
||||
# Python Project Template Functions
|
||||
# ============================================================================
|
||||
# Template-driven project scaffolding for Python applications.
|
||||
# Eliminates code duplication by using a common creation function.
|
||||
# ============================================================================
|
||||
|
||||
source "${0:A:h}/../lib/utils.zsh" 2>/dev/null || \
|
||||
source "$HOME/.dotfiles/zsh/lib/utils.zsh" 2>/dev/null
|
||||
# Source bootstrap (handles all dependencies)
|
||||
source "${0:A:h}/../lib/bootstrap.zsh" 2>/dev/null || \
|
||||
source "$HOME/.dotfiles/zsh/lib/bootstrap.zsh" 2>/dev/null
|
||||
|
||||
# ============================================================================
|
||||
# Configuration
|
||||
# ============================================================================
|
||||
|
||||
typeset -g PY_PYTHON="${PY_PYTHON:-python3}"
|
||||
typeset -g PY_VENV="${PY_VENV:-venv}"
|
||||
typeset -g PY_GIT_INIT="${PY_GIT_INIT:-true}"
|
||||
|
||||
# ============================================================================
|
||||
# Internal Helper Functions
|
||||
# ============================================================================
|
||||
|
||||
# Validate project name and ensure directory doesn't exist
|
||||
_py_check_name() {
|
||||
[[ -z "$1" ]] && { df_print_warning "Project name required"; return 1; }
|
||||
[[ -d "$1" ]] && { df_print_warning "Directory '$1' exists"; return 1; }
|
||||
[[ -d "$1" ]] && { df_print_warning "Directory '$1' already exists"; return 1; }
|
||||
return 0
|
||||
}
|
||||
|
||||
# Create and activate virtual environment
|
||||
_py_venv() {
|
||||
local project_dir="$1"
|
||||
df_print_step "Creating virtual environment"
|
||||
"$PY_PYTHON" -m venv "$1/$PY_VENV"
|
||||
"$PY_PYTHON" -m venv "$project_dir/$PY_VENV"
|
||||
df_print_success "Created: $PY_VENV"
|
||||
}
|
||||
|
||||
# Install packages into project's venv
|
||||
_py_install() {
|
||||
local project_dir="$1"
|
||||
shift
|
||||
local packages=("$@")
|
||||
|
||||
[[ ${#packages[@]} -eq 0 ]] && return 0
|
||||
|
||||
df_print_step "Installing: ${packages[*]}"
|
||||
"$project_dir/$PY_VENV/bin/pip" install "${packages[@]}" -q
|
||||
}
|
||||
|
||||
# Create standard .gitignore for Python projects
|
||||
_py_gitignore() {
|
||||
cat > "$1/.gitignore" << 'EOF'
|
||||
local project_dir="$1"
|
||||
cat > "$project_dir/.gitignore" << 'EOF'
|
||||
# Python
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
*.so
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# Virtual environments
|
||||
venv/
|
||||
.venv/
|
||||
.env
|
||||
*.log
|
||||
ENV/
|
||||
env/
|
||||
|
||||
# IDE
|
||||
.idea/
|
||||
.vscode/
|
||||
*.swp
|
||||
*.swo
|
||||
|
||||
# Testing
|
||||
.pytest_cache/
|
||||
.coverage
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
|
||||
# Type checking
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
|
||||
# Environment
|
||||
.env
|
||||
.env.*
|
||||
*.log
|
||||
|
||||
# Distribution
|
||||
*.manifest
|
||||
*.spec
|
||||
EOF
|
||||
df_print_success "Created .gitignore"
|
||||
}
|
||||
|
||||
# Initialize git repository
|
||||
_py_git() {
|
||||
[[ "$PY_GIT_INIT" == "true" ]] && { cd "$1"; git init; git add .; git commit -m "Initial commit"; df_print_success "Git initialized"; }
|
||||
local project_dir="$1"
|
||||
[[ "$PY_GIT_INIT" != "true" ]] && return 0
|
||||
|
||||
(
|
||||
cd "$project_dir"
|
||||
git init -q
|
||||
git add .
|
||||
git commit -q -m "Initial commit"
|
||||
)
|
||||
df_print_success "Git initialized"
|
||||
}
|
||||
|
||||
_py_next() {
|
||||
# Print next steps for user
|
||||
_py_next_steps() {
|
||||
local project_dir="$1"
|
||||
local extra_info="$2"
|
||||
|
||||
echo ""
|
||||
df_print_section "Next steps"
|
||||
df_print_indent "cd $1"
|
||||
df_print_indent "cd $project_dir"
|
||||
df_print_indent "source $PY_VENV/bin/activate"
|
||||
[[ -n "$extra_info" ]] && df_print_indent "$extra_info"
|
||||
}
|
||||
|
||||
py-new() {
|
||||
_py_check_name "$1" || return 1
|
||||
df_print_func_name "Python Project: $1"
|
||||
mkdir -p "$1"/{src,tests}
|
||||
touch "$1/src/__init__.py" "$1/tests/__init__.py"
|
||||
cat > "$1/src/main.py" << 'EOF'
|
||||
# ============================================================================
|
||||
# Template Definitions
|
||||
# ============================================================================
|
||||
# Each template function creates type-specific files and returns packages to install
|
||||
|
||||
_py_template_basic() {
|
||||
local name="$1"
|
||||
|
||||
# Create directory structure
|
||||
mkdir -p "$name"/{src,tests}
|
||||
touch "$name/src/__init__.py" "$name/tests/__init__.py"
|
||||
|
||||
# Create main.py
|
||||
cat > "$name/src/main.py" << 'EOF'
|
||||
#!/usr/bin/env python3
|
||||
"""Main entry point."""
|
||||
|
||||
|
||||
def main():
|
||||
print("Hello!")
|
||||
"""Main function."""
|
||||
print("Hello, World!")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
EOF
|
||||
echo "# Dependencies" > "$1/requirements.txt"
|
||||
_py_venv "$1"; _py_gitignore "$1"; _py_git "$1"
|
||||
df_print_success "Created: $1"
|
||||
_py_next "$1"
|
||||
|
||||
# Create requirements.txt
|
||||
cat > "$name/requirements.txt" << 'EOF'
|
||||
# Project dependencies
|
||||
# Add your dependencies here
|
||||
EOF
|
||||
|
||||
# Return packages to install (none for basic)
|
||||
echo ""
|
||||
}
|
||||
|
||||
py-flask() {
|
||||
_py_check_name "$1" || return 1
|
||||
df_print_func_name "Flask Project: $1"
|
||||
mkdir -p "$1"/{app/{templates,static},tests}
|
||||
_py_venv "$1"
|
||||
df_print_step "Installing Flask"
|
||||
"$1/$PY_VENV/bin/pip" install flask -q
|
||||
cat > "$1/app/__init__.py" << 'EOF'
|
||||
_py_template_flask() {
|
||||
local name="$1"
|
||||
|
||||
# Create directory structure
|
||||
mkdir -p "$name"/{app/{templates,static/css},tests}
|
||||
|
||||
# Create app/__init__.py
|
||||
cat > "$name/app/__init__.py" << 'EOF'
|
||||
"""Flask application factory."""
|
||||
from flask import Flask
|
||||
def create_app():
|
||||
|
||||
|
||||
def create_app(config_name=None):
|
||||
"""Create and configure the Flask application."""
|
||||
app = Flask(__name__)
|
||||
|
||||
# Load configuration
|
||||
app.config.from_mapping(
|
||||
SECRET_KEY='dev',
|
||||
DEBUG=True,
|
||||
)
|
||||
|
||||
# Register blueprints
|
||||
from app.routes import main
|
||||
app.register_blueprint(main)
|
||||
|
||||
return app
|
||||
EOF
|
||||
cat > "$1/app/routes.py" << 'EOF'
|
||||
|
||||
# Create app/routes.py
|
||||
cat > "$name/app/routes.py" << 'EOF'
|
||||
"""Main application routes."""
|
||||
from flask import Blueprint, render_template
|
||||
|
||||
main = Blueprint('main', __name__)
|
||||
|
||||
|
||||
@main.route('/')
|
||||
def index():
|
||||
"""Home page."""
|
||||
return render_template('index.html')
|
||||
|
||||
|
||||
@main.route('/health')
|
||||
def health():
|
||||
"""Health check endpoint."""
|
||||
return {'status': 'ok'}
|
||||
EOF
|
||||
echo '<!DOCTYPE html><html><body><h1>Flask</h1></body></html>' > "$1/app/templates/index.html"
|
||||
cat > "$1/app.py" << 'EOF'
|
||||
|
||||
# Create template
|
||||
cat > "$name/app/templates/index.html" << 'EOF'
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Flask App</title>
|
||||
<link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">
|
||||
</head>
|
||||
<body>
|
||||
<h1>Welcome to Flask</h1>
|
||||
<p>Your application is running!</p>
|
||||
</body>
|
||||
</html>
|
||||
EOF
|
||||
|
||||
# Create basic CSS
|
||||
cat > "$name/app/static/css/style.css" << 'EOF'
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
||||
max-width: 800px;
|
||||
margin: 0 auto;
|
||||
padding: 2rem;
|
||||
}
|
||||
EOF
|
||||
|
||||
# Create run script
|
||||
cat > "$name/app.py" << 'EOF'
|
||||
#!/usr/bin/env python3
|
||||
"""Application entry point."""
|
||||
from app import create_app
|
||||
|
||||
app = create_app()
|
||||
|
||||
if __name__ == '__main__':
|
||||
app.run(debug=True)
|
||||
app.run(debug=True, host='0.0.0.0', port=5000)
|
||||
EOF
|
||||
echo "Flask>=3.0.0" > "$1/requirements.txt"
|
||||
_py_gitignore "$1"; _py_git "$1"
|
||||
df_print_success "Created: $1"
|
||||
_py_next "$1"
|
||||
|
||||
# Create requirements.txt
|
||||
cat > "$name/requirements.txt" << 'EOF'
|
||||
Flask>=3.0.0
|
||||
python-dotenv>=1.0.0
|
||||
EOF
|
||||
|
||||
# Return packages to install
|
||||
echo "flask python-dotenv"
|
||||
}
|
||||
|
||||
py-fastapi() {
|
||||
_py_check_name "$1" || return 1
|
||||
df_print_func_name "FastAPI Project: $1"
|
||||
mkdir -p "$1"/{app,tests}
|
||||
_py_venv "$1"
|
||||
df_print_step "Installing FastAPI"
|
||||
"$1/$PY_VENV/bin/pip" install fastapi uvicorn -q
|
||||
cat > "$1/app/main.py" << 'EOF'
|
||||
_py_template_fastapi() {
|
||||
local name="$1"
|
||||
|
||||
# Create directory structure
|
||||
mkdir -p "$name"/{app/{routers,models},tests}
|
||||
touch "$name/app/__init__.py" "$name/app/routers/__init__.py" "$name/app/models/__init__.py"
|
||||
|
||||
# Create app/main.py
|
||||
cat > "$name/app/main.py" << 'EOF'
|
||||
"""FastAPI application."""
|
||||
from fastapi import FastAPI
|
||||
app = FastAPI()
|
||||
from fastapi.middleware.cors import CORSMiddleware
|
||||
|
||||
app = FastAPI(
|
||||
title="FastAPI App",
|
||||
description="A FastAPI application",
|
||||
version="0.1.0",
|
||||
)
|
||||
|
||||
# Configure CORS
|
||||
app.add_middleware(
|
||||
CORSMiddleware,
|
||||
allow_origins=["*"],
|
||||
allow_credentials=True,
|
||||
allow_methods=["*"],
|
||||
allow_headers=["*"],
|
||||
)
|
||||
|
||||
|
||||
@app.get("/")
|
||||
def root():
|
||||
return {"message": "Hello"}
|
||||
async def root():
|
||||
"""Root endpoint."""
|
||||
return {"message": "Hello, World!"}
|
||||
|
||||
|
||||
@app.get("/health")
|
||||
def health():
|
||||
async def health():
|
||||
"""Health check endpoint."""
|
||||
return {"status": "ok"}
|
||||
EOF
|
||||
cat > "$1/run.py" << 'EOF'
|
||||
|
||||
# Create run script
|
||||
cat > "$name/run.py" << 'EOF'
|
||||
#!/usr/bin/env python3
|
||||
"""Development server entry point."""
|
||||
import uvicorn
|
||||
|
||||
if __name__ == "__main__":
|
||||
uvicorn.run("app.main:app", host="0.0.0.0", port=8000, reload=True)
|
||||
uvicorn.run(
|
||||
"app.main:app",
|
||||
host="0.0.0.0",
|
||||
port=8000,
|
||||
reload=True,
|
||||
)
|
||||
EOF
|
||||
echo -e "fastapi>=0.104.0\nuvicorn>=0.24.0" > "$1/requirements.txt"
|
||||
_py_gitignore "$1"; _py_git "$1"
|
||||
df_print_success "Created: $1"
|
||||
df_print_info "Docs: http://localhost:8000/docs"
|
||||
_py_next "$1"
|
||||
|
||||
# Create requirements.txt
|
||||
cat > "$name/requirements.txt" << 'EOF'
|
||||
fastapi>=0.109.0
|
||||
uvicorn[standard]>=0.27.0
|
||||
python-dotenv>=1.0.0
|
||||
EOF
|
||||
|
||||
# Return packages to install
|
||||
echo "fastapi uvicorn python-dotenv"
|
||||
}
|
||||
|
||||
py-cli() {
|
||||
_py_check_name "$1" || return 1
|
||||
df_print_func_name "CLI Project: $1"
|
||||
mkdir -p "$1"/{src/$1,tests}
|
||||
_py_venv "$1"
|
||||
df_print_step "Installing click"
|
||||
"$1/$PY_VENV/bin/pip" install click -q
|
||||
echo '__version__ = "0.1.0"' > "$1/src/$1/__init__.py"
|
||||
cat > "$1/src/$1/cli.py" << 'EOF'
|
||||
_py_template_cli() {
|
||||
local name="$1"
|
||||
local pkg_name="${name//-/_}" # Replace hyphens with underscores for Python
|
||||
|
||||
# Create directory structure
|
||||
mkdir -p "$name"/{src/"$pkg_name",tests}
|
||||
|
||||
# Create package __init__.py
|
||||
cat > "$name/src/$pkg_name/__init__.py" << EOF
|
||||
"""${name} - A command-line tool."""
|
||||
__version__ = "0.1.0"
|
||||
EOF
|
||||
|
||||
# Create CLI entry point
|
||||
cat > "$name/src/$pkg_name/cli.py" << 'EOF'
|
||||
#!/usr/bin/env python3
|
||||
"""Command-line interface."""
|
||||
import click
|
||||
|
||||
|
||||
@click.group()
|
||||
@click.version_option()
|
||||
def cli():
|
||||
"""A command-line tool."""
|
||||
pass
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.argument('name', default='World')
|
||||
def greet(name):
|
||||
"""Greet someone by name."""
|
||||
click.echo(f"Hello, {name}!")
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.option('--verbose', '-v', is_flag=True, help='Enable verbose output')
|
||||
def info(verbose):
|
||||
"""Show application information."""
|
||||
click.echo("CLI Application v0.1.0")
|
||||
if verbose:
|
||||
click.echo("Built with Click")
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
cli()
|
||||
EOF
|
||||
echo "click>=8.1.0" > "$1/requirements.txt"
|
||||
_py_gitignore "$1"; _py_git "$1"
|
||||
df_print_success "Created: $1"
|
||||
df_print_info "Install: pip install -e $1"
|
||||
_py_next "$1"
|
||||
|
||||
# Create pyproject.toml for modern packaging
|
||||
cat > "$name/pyproject.toml" << EOF
|
||||
[build-system]
|
||||
requires = ["setuptools>=61.0"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "$name"
|
||||
version = "0.1.0"
|
||||
description = "A command-line tool"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.8"
|
||||
dependencies = [
|
||||
"click>=8.1.0",
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
$name = "${pkg_name}.cli:cli"
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest>=7.0",
|
||||
"pytest-cov",
|
||||
]
|
||||
EOF
|
||||
|
||||
# Create requirements.txt (for compatibility)
|
||||
cat > "$name/requirements.txt" << 'EOF'
|
||||
click>=8.1.0
|
||||
EOF
|
||||
|
||||
# Create README
|
||||
cat > "$name/README.md" << EOF
|
||||
# ${name}
|
||||
|
||||
A command-line tool.
|
||||
|
||||
## Installation
|
||||
|
||||
\`\`\`bash
|
||||
pip install -e .
|
||||
\`\`\`
|
||||
|
||||
## Usage
|
||||
|
||||
\`\`\`bash
|
||||
${name} --help
|
||||
${name} greet World
|
||||
\`\`\`
|
||||
EOF
|
||||
|
||||
# Return packages to install
|
||||
echo "click"
|
||||
}
|
||||
|
||||
_py_template_data() {
|
||||
local name="$1"
|
||||
|
||||
# Create directory structure
|
||||
mkdir -p "$name"/{notebooks,data/{raw,processed},src,tests}
|
||||
touch "$name/src/__init__.py"
|
||||
|
||||
# Create main analysis script
|
||||
cat > "$name/src/analysis.py" << 'EOF'
|
||||
#!/usr/bin/env python3
|
||||
"""Data analysis module."""
|
||||
import pandas as pd
|
||||
import numpy as np
|
||||
|
||||
|
||||
def load_data(filepath):
|
||||
"""Load data from CSV file."""
|
||||
return pd.read_csv(filepath)
|
||||
|
||||
|
||||
def basic_stats(df):
|
||||
"""Calculate basic statistics."""
|
||||
return df.describe()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
print("Data Science Project")
|
||||
print(f"NumPy version: {np.__version__}")
|
||||
print(f"Pandas version: {pd.__version__}")
|
||||
EOF
|
||||
|
||||
# Create sample notebook
|
||||
cat > "$name/notebooks/01_exploration.ipynb" << 'EOF'
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": ["# Data Exploration\n", "\n", "Initial data exploration notebook."]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": ["import pandas as pd\n", "import numpy as np\n", "import matplotlib.pyplot as plt\n", "\n", "%matplotlib inline"]
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"kernelspec": {"display_name": "Python 3", "language": "python", "name": "python3"},
|
||||
"language_info": {"name": "python", "version": "3.10.0"}
|
||||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 4
|
||||
}
|
||||
EOF
|
||||
|
||||
# Create requirements.txt
|
||||
cat > "$name/requirements.txt" << 'EOF'
|
||||
pandas>=2.0.0
|
||||
numpy>=1.24.0
|
||||
matplotlib>=3.7.0
|
||||
seaborn>=0.12.0
|
||||
jupyter>=1.0.0
|
||||
scikit-learn>=1.3.0
|
||||
EOF
|
||||
|
||||
# Create .gitkeep files
|
||||
touch "$name/data/raw/.gitkeep" "$name/data/processed/.gitkeep"
|
||||
|
||||
# Return packages to install
|
||||
echo "pandas numpy matplotlib seaborn jupyter scikit-learn"
|
||||
}
|
||||
|
||||
# ============================================================================
|
||||
# Main Project Creation Function
|
||||
# ============================================================================
|
||||
|
||||
_py_create_project() {
|
||||
local name="$1"
|
||||
local template="$2"
|
||||
local display_name="$3"
|
||||
local extra_info="$4"
|
||||
|
||||
# Validate
|
||||
_py_check_name "$name" || return 1
|
||||
|
||||
# Print header
|
||||
df_print_func_name "${display_name}: ${name}"
|
||||
|
||||
# Create base directory
|
||||
mkdir -p "$name"
|
||||
|
||||
# Run template-specific setup and capture packages
|
||||
local packages
|
||||
packages=$("_py_template_${template}" "$name")
|
||||
|
||||
# Common setup steps
|
||||
_py_venv "$name"
|
||||
|
||||
# Install template-specific packages
|
||||
if [[ -n "$packages" ]]; then
|
||||
_py_install "$name" $packages
|
||||
fi
|
||||
|
||||
# Finalization
|
||||
_py_gitignore "$name"
|
||||
_py_git "$name"
|
||||
|
||||
df_print_success "Created: $name"
|
||||
_py_next_steps "$name" "$extra_info"
|
||||
}
|
||||
|
||||
# ============================================================================
|
||||
# Public API Functions
|
||||
# ============================================================================
|
||||
|
||||
py-new() {
|
||||
_py_create_project "$1" "basic" "Python Project"
|
||||
}
|
||||
|
||||
py-flask() {
|
||||
_py_create_project "$1" "flask" "Flask Project" "Run: python app.py"
|
||||
}
|
||||
|
||||
py-fastapi() {
|
||||
_py_create_project "$1" "fastapi" "FastAPI Project" "Run: python run.py | Docs: http://localhost:8000/docs"
|
||||
}
|
||||
|
||||
py-cli() {
|
||||
_py_create_project "$1" "cli" "CLI Project" "Install: pip install -e ."
|
||||
}
|
||||
|
||||
py-data() {
|
||||
_py_create_project "$1" "data" "Data Science Project" "Start Jupyter: jupyter notebook"
|
||||
}
|
||||
|
||||
# Quick venv activation helper
|
||||
venv() {
|
||||
[[ -d "venv" ]] && source venv/bin/activate && return
|
||||
[[ -d ".venv" ]] && source .venv/bin/activate && return
|
||||
df_print_error "No venv found"
|
||||
local venv_dirs=("venv" ".venv" "env" ".env")
|
||||
for dir in "${venv_dirs[@]}"; do
|
||||
if [[ -f "$dir/bin/activate" ]]; then
|
||||
source "$dir/bin/activate"
|
||||
df_print_success "Activated: $dir"
|
||||
return 0
|
||||
fi
|
||||
done
|
||||
df_print_error "No virtual environment found"
|
||||
df_print_info "Create one with: python -m venv venv"
|
||||
return 1
|
||||
}
|
||||
|
||||
alias pynew='py-new' pyflask='py-flask' pyfast='py-fastapi' pycli='py-cli'
|
||||
# List available templates
|
||||
py-templates() {
|
||||
df_print_func_name "Python Project Templates"
|
||||
echo ""
|
||||
df_print_indent "py-new <name> Basic Python project"
|
||||
df_print_indent "py-flask <name> Flask web application"
|
||||
df_print_indent "py-fastapi <name> FastAPI REST API"
|
||||
df_print_indent "py-cli <name> CLI tool with Click"
|
||||
df_print_indent "py-data <name> Data science project"
|
||||
echo ""
|
||||
df_print_info "Example: py-flask mywebapp"
|
||||
}
|
||||
|
||||
# ============================================================================
|
||||
# Aliases
|
||||
# ============================================================================
|
||||
|
||||
alias pynew='py-new'
|
||||
alias pyflask='py-flask'
|
||||
alias pyfast='py-fastapi'
|
||||
alias pycli='py-cli'
|
||||
alias pydata='py-data'
|
||||
alias pytemplates='py-templates'
|
||||
|
||||
135
zsh/lib/bootstrap.zsh
Normal file
135
zsh/lib/bootstrap.zsh
Normal file
@@ -0,0 +1,135 @@
|
||||
# ============================================================================
|
||||
# Dotfiles Bootstrap - Single Entry Point
|
||||
# ============================================================================
|
||||
# This is the ONE file to source in all scripts and functions.
|
||||
# It handles loading config, colors, and utils in the correct order with
|
||||
# proper fallbacks.
|
||||
#
|
||||
# Usage in zsh functions:
|
||||
# source "${0:A:h}/../lib/bootstrap.zsh"
|
||||
#
|
||||
# Usage in bash scripts:
|
||||
# source "${DOTFILES_HOME:-$HOME/.dotfiles}/zsh/lib/bootstrap.zsh"
|
||||
#
|
||||
# After sourcing, you have access to:
|
||||
# - All DF_* color variables
|
||||
# - All df_print_* functions
|
||||
# - All df_* utility functions
|
||||
# - All config variables from dotfiles.conf
|
||||
# ============================================================================
|
||||
|
||||
# Prevent double-sourcing (works in both bash and zsh)
|
||||
[[ -n "$_DF_BOOTSTRAP_LOADED" ]] && return 0
|
||||
|
||||
# ============================================================================
|
||||
# Determine Dotfiles Root
|
||||
# ============================================================================
|
||||
|
||||
_df_find_root() {
|
||||
# Check common locations in order of preference
|
||||
local locations=(
|
||||
"${DOTFILES_DIR}"
|
||||
"${DOTFILES_HOME}"
|
||||
"$HOME/.dotfiles"
|
||||
)
|
||||
|
||||
for loc in "${locations[@]}"; do
|
||||
[[ -n "$loc" && -d "$loc" && -f "$loc/dotfiles.conf" ]] && {
|
||||
echo "$loc"
|
||||
return 0
|
||||
}
|
||||
done
|
||||
|
||||
# Fallback: try to find from script location (zsh)
|
||||
if [[ -n "$ZSH_VERSION" ]]; then
|
||||
local script_dir="${0:A:h}"
|
||||
# Walk up looking for dotfiles.conf
|
||||
while [[ "$script_dir" != "/" ]]; do
|
||||
[[ -f "$script_dir/dotfiles.conf" ]] && { echo "$script_dir"; return 0; }
|
||||
script_dir="${script_dir:h}"
|
||||
done
|
||||
fi
|
||||
|
||||
# Last resort
|
||||
echo "$HOME/.dotfiles"
|
||||
}
|
||||
|
||||
# Set the root directory
|
||||
typeset -g _DF_ROOT="$(_df_find_root)"
|
||||
typeset -g DOTFILES_DIR="$_DF_ROOT"
|
||||
typeset -g DOTFILES_HOME="$_DF_ROOT"
|
||||
|
||||
# ============================================================================
|
||||
# Source Core Files (in correct order)
|
||||
# ============================================================================
|
||||
|
||||
# 1. Config first (sets DF_WIDTH, MOTD_STYLE, etc.)
|
||||
if [[ -f "$_DF_ROOT/zsh/lib/config.zsh" ]]; then
|
||||
source "$_DF_ROOT/zsh/lib/config.zsh"
|
||||
else
|
||||
# Minimal fallback config
|
||||
typeset -g DOTFILES_VERSION="${DOTFILES_VERSION:-1.0.0}"
|
||||
typeset -g DF_WIDTH="${DF_WIDTH:-66}"
|
||||
typeset -g MOTD_STYLE="${MOTD_STYLE:-compact}"
|
||||
typeset -g DOTFILES_BRANCH="${DOTFILES_BRANCH:-main}"
|
||||
fi
|
||||
|
||||
# 2. Colors second
|
||||
if [[ -f "$_DF_ROOT/zsh/lib/colors.zsh" ]]; then
|
||||
source "$_DF_ROOT/zsh/lib/colors.zsh"
|
||||
else
|
||||
# Minimal fallback colors
|
||||
typeset -g DF_RED=$'\033[0;31m'
|
||||
typeset -g DF_GREEN=$'\033[0;32m'
|
||||
typeset -g DF_YELLOW=$'\033[1;33m'
|
||||
typeset -g DF_BLUE=$'\033[0;34m'
|
||||
typeset -g DF_CYAN=$'\033[0;36m'
|
||||
typeset -g DF_NC=$'\033[0m'
|
||||
typeset -g DF_GREY=$'\033[38;5;242m'
|
||||
typeset -g DF_LIGHT_BLUE=$'\033[38;5;39m'
|
||||
typeset -g DF_LIGHT_GREEN=$'\033[38;5;82m'
|
||||
typeset -g DF_BOLD=$'\033[1m'
|
||||
typeset -g DF_DIM=$'\033[2m'
|
||||
fi
|
||||
|
||||
# 3. Utils last (depends on config and colors)
|
||||
if [[ -f "$_DF_ROOT/zsh/lib/utils.zsh" ]]; then
|
||||
source "$_DF_ROOT/zsh/lib/utils.zsh"
|
||||
fi
|
||||
|
||||
# ============================================================================
|
||||
# Ensure Critical Functions Exist
|
||||
# ============================================================================
|
||||
# If utils.zsh failed to load, provide minimal implementations
|
||||
|
||||
if ! declare -f df_print_header &>/dev/null; then
|
||||
df_print_header() {
|
||||
local name="${1:-script}"
|
||||
echo ""
|
||||
echo "=== ${name} ==="
|
||||
echo ""
|
||||
}
|
||||
fi
|
||||
|
||||
if ! declare -f df_print_func_name &>/dev/null; then
|
||||
df_print_func_name() {
|
||||
echo "--- ${1:-function} ---"
|
||||
}
|
||||
fi
|
||||
|
||||
if ! declare -f df_print_success &>/dev/null; then
|
||||
df_print_success() { echo "✓ $1"; }
|
||||
df_print_error() { echo "✗ $1" >&2; }
|
||||
df_print_warning() { echo "⚠ $1"; }
|
||||
df_print_info() { echo "ℹ $1"; }
|
||||
df_print_step() { echo "==> $1"; }
|
||||
fi
|
||||
|
||||
# ============================================================================
|
||||
# Mark as Loaded
|
||||
# ============================================================================
|
||||
|
||||
typeset -g _DF_BOOTSTRAP_LOADED=1
|
||||
|
||||
# Export for subshells (bash compatibility)
|
||||
export DOTFILES_DIR DOTFILES_HOME DOTFILES_VERSION DF_WIDTH
|
||||
@@ -4,7 +4,7 @@
|
||||
# Source this file in scripts and functions to get consistent color support.
|
||||
#
|
||||
# Usage in zsh functions:
|
||||
# source "${0:A:h}/../lib/colors.zsh" 2>/dev/null || source "$HOME/.dotfiles/zsh/lib/colors.zsh"
|
||||
# source "${0:A:h}/../lib/colors.zsh"
|
||||
#
|
||||
# Usage in bash scripts:
|
||||
# source "$HOME/.dotfiles/zsh/lib/colors.zsh"
|
||||
|
||||
@@ -3,10 +3,10 @@
|
||||
# ============================================================================
|
||||
# Common helper functions used across multiple function files.
|
||||
#
|
||||
# This file sources config.zsh (which sources dotfiles.conf) and colors.zsh,
|
||||
# so sourcing this single file gives you access to everything.
|
||||
# This file is typically sourced via bootstrap.zsh, which handles loading
|
||||
# config.zsh and colors.zsh first.
|
||||
#
|
||||
# Source this file in function files:
|
||||
# Direct usage (if needed):
|
||||
# source "${0:A:h}/../lib/utils.zsh"
|
||||
# ============================================================================
|
||||
|
||||
@@ -15,65 +15,52 @@
|
||||
typeset -g _DF_UTILS_LOADED=1
|
||||
|
||||
# ============================================================================
|
||||
# Source Configuration and Colors
|
||||
# Source Dependencies (if not already loaded via bootstrap)
|
||||
# ============================================================================
|
||||
# Order matters: config first (sets DF_WIDTH, etc.), then colors
|
||||
|
||||
# Find lib directory
|
||||
_df_lib_dir="${0:A:h}"
|
||||
[[ ! -d "$_df_lib_dir" ]] && _df_lib_dir="$HOME/.dotfiles/zsh/lib"
|
||||
|
||||
# Source config (provides all settings from dotfiles.conf)
|
||||
source "${_df_lib_dir}/config.zsh" 2>/dev/null || \
|
||||
source "$HOME/.dotfiles/zsh/lib/config.zsh" 2>/dev/null || {
|
||||
# Fallback: set critical defaults if config.zsh not found
|
||||
typeset -g DOTFILES_DIR="${DOTFILES_DIR:-$HOME/.dotfiles}"
|
||||
typeset -g DOTFILES_HOME="${DOTFILES_HOME:-$DOTFILES_DIR}"
|
||||
typeset -g DOTFILES_VERSION="${DOTFILES_VERSION:-unknown}"
|
||||
typeset -g DF_WIDTH="${DF_WIDTH:-66}"
|
||||
# Source config if not already loaded
|
||||
[[ -z "$_DF_CONFIG_LOADED" ]] && {
|
||||
source "${_df_lib_dir}/config.zsh" 2>/dev/null || \
|
||||
source "$HOME/.dotfiles/zsh/lib/config.zsh" 2>/dev/null || {
|
||||
typeset -g DOTFILES_DIR="${DOTFILES_DIR:-$HOME/.dotfiles}"
|
||||
typeset -g DOTFILES_HOME="${DOTFILES_HOME:-$DOTFILES_DIR}"
|
||||
typeset -g DOTFILES_VERSION="${DOTFILES_VERSION:-unknown}"
|
||||
typeset -g DF_WIDTH="${DF_WIDTH:-66}"
|
||||
}
|
||||
}
|
||||
|
||||
# Source colors
|
||||
source "${_df_lib_dir}/colors.zsh" 2>/dev/null || \
|
||||
source "$HOME/.dotfiles/zsh/lib/colors.zsh" 2>/dev/null || {
|
||||
# Fallback colors if colors.zsh not found
|
||||
typeset -g DF_RED=$'\033[0;31m' DF_GREEN=$'\033[0;32m' DF_YELLOW=$'\033[1;33m'
|
||||
typeset -g DF_BLUE=$'\033[0;34m' DF_CYAN=$'\033[0;36m' DF_NC=$'\033[0m'
|
||||
typeset -g DF_GREY=$'\033[38;5;242m' DF_LIGHT_BLUE=$'\033[38;5;39m'
|
||||
typeset -g DF_LIGHT_GREEN=$'\033[38;5;82m' DF_BOLD=$'\033[1m' DF_DIM=$'\033[2m'
|
||||
# Source colors if not already loaded
|
||||
[[ -z "$_DF_COLORS_LOADED" ]] && {
|
||||
source "${_df_lib_dir}/colors.zsh" 2>/dev/null || \
|
||||
source "$HOME/.dotfiles/zsh/lib/colors.zsh" 2>/dev/null || {
|
||||
typeset -g DF_RED=$'\033[0;31m' DF_GREEN=$'\033[0;32m' DF_YELLOW=$'\033[1;33m'
|
||||
typeset -g DF_BLUE=$'\033[0;34m' DF_CYAN=$'\033[0;36m' DF_NC=$'\033[0m'
|
||||
typeset -g DF_GREY=$'\033[38;5;242m' DF_LIGHT_BLUE=$'\033[38;5;39m'
|
||||
typeset -g DF_LIGHT_GREEN=$'\033[38;5;82m' DF_BOLD=$'\033[1m' DF_DIM=$'\033[2m'
|
||||
}
|
||||
}
|
||||
|
||||
unset _df_lib_dir
|
||||
|
||||
# ============================================================================
|
||||
# MOTD-Style Header Functions
|
||||
# Header Box Drawing (Centralized Implementation)
|
||||
# ============================================================================
|
||||
# These functions eliminate header duplication across all scripts.
|
||||
|
||||
# Prints a standardized header box for functions
|
||||
# Usage: df_print_func_name "Function Name"
|
||||
df_print_func_name() {
|
||||
local func_name="${1:-func}"
|
||||
local datetime=$(date '+%a %b %d %H:%M')
|
||||
local width="${DF_WIDTH:-66}"
|
||||
|
||||
# Build horizontal line
|
||||
local hline=""
|
||||
for ((i=0; i<width; i++)); do hline+="═"; done
|
||||
local inner=$((width - 2))
|
||||
|
||||
# Header content
|
||||
local h_left="${func_name}"
|
||||
local h_right="${datetime}"
|
||||
local h_pad=$((inner - ${#h_left} - ${#h_right}))
|
||||
local h_spaces=""
|
||||
for ((i=0; i<h_pad; i++)); do h_spaces+=" "; done
|
||||
|
||||
echo -e "${DF_GREY}╒${hline}╕${DF_NC}"
|
||||
echo -e "${DF_GREY}│${DF_NC} ${DF_BOLD}${DF_LIGHT_BLUE}${h_left}${DF_NC}${h_spaces}${DF_NC}${DF_BOLD}${h_right}${DF_NC} ${DF_GREY}│${DF_NC}"
|
||||
echo -e "${DF_GREY}╘${hline}╛${DF_NC}"
|
||||
# Build a horizontal line of specified character and width
|
||||
# Usage: _df_hline "═" 66
|
||||
_df_hline() {
|
||||
local char="${1:-═}"
|
||||
local width="${2:-$DF_WIDTH}"
|
||||
local line=""
|
||||
for ((i=0; i<width; i++)); do line+="$char"; done
|
||||
echo "$line"
|
||||
}
|
||||
|
||||
# Prints a standardized header box for scripts
|
||||
# Print a MOTD-style header box for scripts
|
||||
# Usage: df_print_header "script-name"
|
||||
df_print_header() {
|
||||
local script_name="${1:-script}"
|
||||
@@ -83,29 +70,68 @@ df_print_header() {
|
||||
local width="${DF_WIDTH:-66}"
|
||||
|
||||
# Build horizontal line
|
||||
local hline=""
|
||||
for ((i=0; i<width; i++)); do hline+="═"; done
|
||||
local hline=$(_df_hline "═" "$width")
|
||||
local inner=$((width - 2))
|
||||
|
||||
# Header content
|
||||
local h_left="✦ ${user}@${hostname}"
|
||||
local h_center="${script_name}"
|
||||
local h_right="${datetime}"
|
||||
local h_pad=$(((inner - ${#h_left} - ${#h_center} - ${#h_right}) / 2))
|
||||
local h_spaces=""
|
||||
for ((i=0; i<h_pad; i++)); do h_spaces+=" "; done
|
||||
|
||||
# Calculate padding (distribute space evenly)
|
||||
local content_len=$((${#h_left} + ${#h_center} + ${#h_right}))
|
||||
local total_padding=$((inner - content_len))
|
||||
local left_pad=$((total_padding / 2))
|
||||
local right_pad=$((total_padding - left_pad))
|
||||
|
||||
# Build padding strings
|
||||
local left_spaces="" right_spaces=""
|
||||
for ((i=0; i<left_pad; i++)); do left_spaces+=" "; done
|
||||
for ((i=0; i<right_pad; i++)); do right_spaces+=" "; done
|
||||
|
||||
# Use red for root, light blue for normal users
|
||||
local user_color="${DF_LIGHT_BLUE}"
|
||||
[[ "$EUID" -eq 0 ]] && user_color="${DF_RED}"
|
||||
[[ "${EUID:-$(id -u)}" -eq 0 ]] && user_color="${DF_RED}"
|
||||
|
||||
echo ""
|
||||
echo -e "${DF_GREY}╒${hline}╕${DF_NC}"
|
||||
echo -e "${DF_GREY}│${DF_NC} ${DF_BOLD}${user_color}${h_left}${DF_NC}${h_spaces}${DF_LIGHT_GREEN}${h_center}${h_spaces}${DF_NC}${DF_BOLD}${h_right}${DF_NC} ${DF_GREY}│${DF_NC}"
|
||||
echo -e "${DF_GREY}│${DF_NC} ${DF_BOLD}${user_color}${h_left}${DF_NC}${left_spaces}${DF_LIGHT_GREEN}${h_center}${right_spaces}${DF_NC}${DF_BOLD}${h_right}${DF_NC} ${DF_GREY}│${DF_NC}"
|
||||
echo -e "${DF_GREY}╘${hline}╛${DF_NC}"
|
||||
echo ""
|
||||
}
|
||||
|
||||
# Print a header box for functions (simpler, no user@host)
|
||||
# Usage: df_print_func_name "Function Name"
|
||||
df_print_func_name() {
|
||||
local func_name="${1:-func}"
|
||||
local datetime=$(date '+%a %b %d %H:%M')
|
||||
local width="${DF_WIDTH:-66}"
|
||||
|
||||
# Build horizontal line
|
||||
local hline=$(_df_hline "═" "$width")
|
||||
local inner=$((width - 2))
|
||||
|
||||
# Header content (function name on left, datetime on right)
|
||||
local h_left="${func_name}"
|
||||
local h_right="${datetime}"
|
||||
local h_pad=$((inner - ${#h_left} - ${#h_right}))
|
||||
|
||||
local h_spaces=""
|
||||
for ((i=0; i<h_pad; i++)); do h_spaces+=" "; done
|
||||
|
||||
echo -e "${DF_GREY}╒${hline}╕${DF_NC}"
|
||||
echo -e "${DF_GREY}│${DF_NC} ${DF_BOLD}${DF_LIGHT_BLUE}${h_left}${DF_NC}${h_spaces}${DF_BOLD}${h_right}${DF_NC} ${DF_GREY}│${DF_NC}"
|
||||
echo -e "${DF_GREY}╘${hline}╛${DF_NC}"
|
||||
}
|
||||
|
||||
# Print a simple section divider line
|
||||
# Usage: df_print_divider
|
||||
df_print_divider() {
|
||||
local width="${DF_WIDTH:-66}"
|
||||
local line=$(_df_hline "─" "$width")
|
||||
echo -e "${DF_CYAN}${line}${DF_NC}"
|
||||
}
|
||||
|
||||
# ============================================================================
|
||||
# Output Formatting Functions
|
||||
# ============================================================================
|
||||
@@ -142,9 +168,16 @@ df_require_cmd() {
|
||||
|
||||
df_confirm() {
|
||||
local prompt="$1"
|
||||
read -q "REPLY?$prompt [y/N]: "
|
||||
echo
|
||||
[[ "$REPLY" =~ ^[Yy]$ ]]
|
||||
local response
|
||||
|
||||
if [[ -n "$ZSH_VERSION" ]]; then
|
||||
read -q "response?$prompt [y/N]: "
|
||||
echo
|
||||
[[ "$response" =~ ^[Yy]$ ]]
|
||||
else
|
||||
read -p "$prompt [y/N]: " response
|
||||
[[ "$response" =~ ^[Yy]$ ]]
|
||||
fi
|
||||
}
|
||||
|
||||
df_confirm_warning() {
|
||||
|
||||
Reference in New Issue
Block a user