summaryrefslogtreecommitdiffstats
path: root/Makefile
blob: 7d5229ab8f4cb785972046117f6fcb4779851a19 (plain)
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

SHELL = /bin/bash
.SHELLFLAGS = -o pipefail -c
TODAY ?= $(shell date --iso --utc)

.PHONY: help
help: ## Print info about all commands
	@echo "Commands:"
	@echo
	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "    \033[01;32m%-20s\033[0m %s\n", $$1, $$2}'

.PHONY: dep
dep: ## Install dependencies using pipenv
	pipenv install --dev

.PHONY: lint
lint: ## Run lints (eg, flake8, mypy)
	pipenv run flake8 grobid_tei_xml/ tests/ --exit-zero
	pipenv run mypy grobid_tei_xml/ tests/ --ignore-missing-imports

.PHONY: fmt
fmt: ## Run code formating on all source code
	pipenv run isort --atomic grobid_tei_xml/*.py
	pipenv run yapf -p -i -r grobid_tei_xml tests

.PHONY: test
test: ## Run all tests and lints
	pipenv run python -m pytest -vv

.PHONY: test-readme
test-readme: ## Test codeblocks in the README (includes live web requests)
	pipenv run python -m pytest --codeblocks

.PHONY: coverage
coverage: ## Run all tests with coverage
	pipenv run python -m pytest --cov --cov-report=term --cov-report=html