feat: project bootstrap and structure
Sprint 1 initialization: - Project directory structure (portfolio_app/, tests/, dbt/, data/, scripts/) - CLAUDE.md with AI assistant context - pyproject.toml with all dependencies - docker-compose.yml for PostgreSQL 16 + PostGIS - Makefile with standard targets - Pre-commit configuration (ruff, mypy) - Environment template (.env.example) - Error handling foundation (PortfolioError hierarchy) - Test configuration (conftest.py, pytest config) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
157
Makefile
Normal file
157
Makefile
Normal file
@@ -0,0 +1,157 @@
|
||||
.PHONY: setup docker-up docker-down db-init run test dbt-run dbt-test lint format ci deploy clean help
|
||||
|
||||
# Default target
|
||||
.DEFAULT_GOAL := help
|
||||
|
||||
# Environment
|
||||
PYTHON := python3
|
||||
PIP := pip
|
||||
DOCKER_COMPOSE := docker compose
|
||||
|
||||
# Colors for output
|
||||
BLUE := \033[0;34m
|
||||
GREEN := \033[0;32m
|
||||
YELLOW := \033[0;33m
|
||||
NC := \033[0m
|
||||
|
||||
help: ## Show this help message
|
||||
@echo "Usage: make [target]"
|
||||
@echo ""
|
||||
@echo "Targets:"
|
||||
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf " $(BLUE)%-15s$(NC) %s\n", $$1, $$2}'
|
||||
|
||||
# =============================================================================
|
||||
# Setup
|
||||
# =============================================================================
|
||||
|
||||
setup: ## Install dependencies, create .env, init pre-commit
|
||||
@echo "$(GREEN)Installing dependencies...$(NC)"
|
||||
$(PIP) install -e ".[dev,dbt]"
|
||||
@echo "$(GREEN)Setting up environment...$(NC)"
|
||||
@if [ ! -f .env ]; then cp .env.example .env; echo "$(YELLOW)Created .env from .env.example - please update values$(NC)"; fi
|
||||
@echo "$(GREEN)Installing pre-commit hooks...$(NC)"
|
||||
pre-commit install
|
||||
@echo "$(GREEN)Setup complete!$(NC)"
|
||||
|
||||
# =============================================================================
|
||||
# Docker
|
||||
# =============================================================================
|
||||
|
||||
docker-up: ## Start PostgreSQL + PostGIS containers
|
||||
@echo "$(GREEN)Starting database containers...$(NC)"
|
||||
$(DOCKER_COMPOSE) up -d
|
||||
@echo "$(GREEN)Waiting for database to be ready...$(NC)"
|
||||
@sleep 3
|
||||
@echo "$(GREEN)Database containers started!$(NC)"
|
||||
|
||||
docker-down: ## Stop containers
|
||||
@echo "$(YELLOW)Stopping containers...$(NC)"
|
||||
$(DOCKER_COMPOSE) down
|
||||
|
||||
docker-logs: ## View container logs
|
||||
$(DOCKER_COMPOSE) logs -f
|
||||
|
||||
# =============================================================================
|
||||
# Database
|
||||
# =============================================================================
|
||||
|
||||
db-init: ## Initialize database schema
|
||||
@echo "$(GREEN)Initializing database schema...$(NC)"
|
||||
@if [ -f scripts/db/init.sh ]; then \
|
||||
bash scripts/db/init.sh; \
|
||||
else \
|
||||
echo "$(YELLOW)scripts/db/init.sh not found - skipping$(NC)"; \
|
||||
fi
|
||||
|
||||
db-reset: ## Drop and recreate database (DESTRUCTIVE)
|
||||
@echo "$(YELLOW)WARNING: This will delete all data!$(NC)"
|
||||
@read -p "Are you sure? [y/N] " confirm && [ "$$confirm" = "y" ] || exit 1
|
||||
$(DOCKER_COMPOSE) down -v
|
||||
$(DOCKER_COMPOSE) up -d
|
||||
@sleep 3
|
||||
$(MAKE) db-init
|
||||
|
||||
# =============================================================================
|
||||
# Application
|
||||
# =============================================================================
|
||||
|
||||
run: ## Start Dash development server
|
||||
@echo "$(GREEN)Starting Dash server...$(NC)"
|
||||
$(PYTHON) -m portfolio_app.app
|
||||
|
||||
# =============================================================================
|
||||
# Testing
|
||||
# =============================================================================
|
||||
|
||||
test: ## Run pytest
|
||||
@echo "$(GREEN)Running tests...$(NC)"
|
||||
pytest
|
||||
|
||||
test-cov: ## Run pytest with coverage
|
||||
@echo "$(GREEN)Running tests with coverage...$(NC)"
|
||||
pytest --cov=portfolio_app --cov-report=html --cov-report=term
|
||||
|
||||
# =============================================================================
|
||||
# dbt
|
||||
# =============================================================================
|
||||
|
||||
dbt-run: ## Run dbt models
|
||||
@echo "$(GREEN)Running dbt models...$(NC)"
|
||||
cd dbt && dbt run
|
||||
|
||||
dbt-test: ## Run dbt tests
|
||||
@echo "$(GREEN)Running dbt tests...$(NC)"
|
||||
cd dbt && dbt test
|
||||
|
||||
dbt-docs: ## Generate dbt documentation
|
||||
@echo "$(GREEN)Generating dbt docs...$(NC)"
|
||||
cd dbt && dbt docs generate && dbt docs serve
|
||||
|
||||
# =============================================================================
|
||||
# Code Quality
|
||||
# =============================================================================
|
||||
|
||||
lint: ## Run ruff linter
|
||||
@echo "$(GREEN)Running linter...$(NC)"
|
||||
ruff check .
|
||||
|
||||
format: ## Run ruff formatter
|
||||
@echo "$(GREEN)Formatting code...$(NC)"
|
||||
ruff format .
|
||||
ruff check --fix .
|
||||
|
||||
typecheck: ## Run mypy type checker
|
||||
@echo "$(GREEN)Running type checker...$(NC)"
|
||||
mypy portfolio_app
|
||||
|
||||
ci: ## Run all checks (lint, typecheck, test)
|
||||
@echo "$(GREEN)Running CI checks...$(NC)"
|
||||
$(MAKE) lint
|
||||
$(MAKE) typecheck
|
||||
$(MAKE) test
|
||||
@echo "$(GREEN)All checks passed!$(NC)"
|
||||
|
||||
# =============================================================================
|
||||
# Deployment
|
||||
# =============================================================================
|
||||
|
||||
deploy: ## Deploy to production
|
||||
@echo "$(YELLOW)Deployment not yet configured$(NC)"
|
||||
@echo "TODO: Add deployment script"
|
||||
|
||||
# =============================================================================
|
||||
# Cleanup
|
||||
# =============================================================================
|
||||
|
||||
clean: ## Remove build artifacts and caches
|
||||
@echo "$(YELLOW)Cleaning up...$(NC)"
|
||||
rm -rf build/
|
||||
rm -rf dist/
|
||||
rm -rf *.egg-info/
|
||||
rm -rf .pytest_cache/
|
||||
rm -rf .ruff_cache/
|
||||
rm -rf .mypy_cache/
|
||||
rm -rf htmlcov/
|
||||
rm -rf .coverage
|
||||
find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
|
||||
@echo "$(GREEN)Clean complete!$(NC)"
|
||||
Reference in New Issue
Block a user