Guardian/Makefile at main · prithvee07/Guardian · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# Makefile for Guardian CLI
# Automation of common development and deployment tasks

# -----------------------------------------------------------------------------
# Variables
# -----------------------------------------------------------------------------
VENV := .venv
PYTHON := $(VENV)/bin/python
PIP := $(PYTHON) -m pip
DOCKER := docker
DOCKER_COMPOSE := docker-compose
APP_NAME := guardian-cli
IMAGE_NAME := guardian-cli
VERSION := $(shell grep "version =" pyproject.toml | head -n 1 | cut -d '"' -f 2)

# Colors for help message
CYAN := \033[36m
RESET := \033[0m

# -----------------------------------------------------------------------------
# Default target
# -----------------------------------------------------------------------------
.DEFAULT_GOAL := help

# -----------------------------------------------------------------------------
# Help
# -----------------------------------------------------------------------------
.PHONY: help
help: ## Display this help message
	@echo "Usage: make [target]"
	@echo ""
	@echo "Targets:"
	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "  $(CYAN)%-20s$(RESET) %s\n", $$1, $$2}' $(MAKEFILE_LIST)

# -----------------------------------------------------------------------------
# Development
# -----------------------------------------------------------------------------
.PHONY: venv
venv: ## Create virtual environment
	test -d $(VENV) || python3 -m venv $(VENV)

.PHONY: setup
setup: venv ## Initialize development environment (.env, venv, directories)
	test -f .env || cp .env.example .env
	mkdir -p reports logs
	# @echo " Environment initialized. Please edit .env with your API keys."

.PHONY: install
# -----------------------------------------------------------------------------
.PHONY: install
install: venv ## Install dependencies for development
	$(PIP) install -e ".[dev]"

.PHONY: update
update: ## Update dependencies
	$(PIP) install --upgrade -e ".[dev]"

.PHONY: clean
clean: ## Clean up build artifacts and cache
	rm -rf build/ dist/ *.egg-info .pytest_cache .ruff_cache
	find . -type d -name "__pycache__" -exec rm -rf {} +
	find . -type f -name "*.pyc" -delete

# -----------------------------------------------------------------------------
# Quality Assurance
# -----------------------------------------------------------------------------
.PHONY: lint
lint: ## Run linting (ruff & black check)
	ruff check .
	black --check .

.PHONY: format
format: ## Format code (black & ruff fix)
	black .
	ruff check --fix .

.PHONY: test
test: ## Run tests
	pytest

# -----------------------------------------------------------------------------
# Docker
# -----------------------------------------------------------------------------
.PHONY: docker-build
docker-build: ## Build the Docker image
	$(DOCKER) build -t $(IMAGE_NAME):latest -t $(IMAGE_NAME):$(VERSION) .

.PHONY: docker-run
docker-run: ## Run the Docker container
	$(DOCKER) run --rm -it $(IMAGE_NAME):latest

.PHONY: compose-up
compose-up: ## Start services with Docker Compose
	$(DOCKER_COMPOSE) up -d

.PHONY: compose-down
compose-down: ## Stop services with Docker Compose
	$(DOCKER_COMPOSE) down

.PHONY: compose-logs
compose-logs: ## View logs from Docker Compose services
	$(DOCKER_COMPOSE) logs -f

# -----------------------------------------------------------------------------
# CLI Execution
# -----------------------------------------------------------------------------
.PHONY: run
run: ## Run the CLI tool (usage: make run ARGS="scan --target example.com")
	$(PYTHON) -m cli.main $(ARGS)