forked from buildinspace/peru
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds a Makefile to facilitate common development tasks
When working on buildinspace#219, I found it repetitive to use history to invoke commands when I could just type "make" like I do in many other projects, including my Python projects. I extracted therefrom this minimalistic Makefile and added references to it in CONTRIBUTING. I also cleaned up some markup in CONTRIBUTING.
- Loading branch information
1 parent
e9ba6e0
commit 802e975
Showing
2 changed files
with
76 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
PYTHON ?= python3 | ||
FLAKE8 ?= flake8 | ||
PIP ?= pip3 | ||
|
||
VENV ?= .venv | ||
|
||
##@ Code Quality | ||
|
||
.PHONY: all | ||
all: check test ## Run all checks and tests | ||
|
||
.PHONY: test | ||
test: ## Run all tests | ||
$(PYTHON) test.py -v | ||
|
||
.PHONY: check | ||
check: ## Run all checks | ||
$(FLAKE8) peru tests | ||
|
||
##@ Dev Env Setup | ||
|
||
.PHONY: venv | ||
venv: ## Create a venv | ||
$(PYTHON) -m venv --clear $(VENV) | ||
@echo "Activate the venv with 'source $(VENV)/bin/activate'" | ||
|
||
.PHONY: deps-dev | ||
deps-dev: ## Install development dependencies | ||
$(PIP) install -r requirements-dev.txt | ||
|
||
##@ Utility | ||
|
||
.PHONY: help | ||
help: ## Display this help | ||
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[\#a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) |