generated from ICRAR/daliuge-component-template
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
133 lines (117 loc) · 4.73 KB
/
Makefile
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
.ONESHELL:
ENV_PREFIX=$(shell python -c "if __import__('pathlib').Path('.venv/bin/pip').exists(): print('.venv/bin/')")
USING_POETRY=$(shell grep "tool.poetry" pyproject.toml && echo "yes")
DLG_CONTRIB=$(shell echo $(DLG_ROOT)/code)
.PHONY: help
help: ## Show the help.
@echo "Usage: make <target>"
@echo ""
@echo "Targets:"
@fgrep "##" Makefile | fgrep -v fgrep
.PHONY: show
show: ## Show the current environment.
@echo "Current environment:"
@if [ "$(USING_POETRY)" ]; then poetry env info && exit; fi
@echo "Running using $(ENV_PREFIX)"
@$(ENV_PREFIX)python -V
@$(ENV_PREFIX)python -m site
.PHONY: install
install: ## Install the project in dev mode.
@if [ "$(USING_POETRY)" ]; then poetry install && exit; fi
@echo "Don't forget to run 'make virtualenv' if you got errors."
$(ENV_PREFIX)pip install -e .[test]
.PHONY: dlginstall
dlginstall: ## Install into $DLG_ROOT/code
@if [ !"$(DLG_ROOT)" ]
@then
@ DLG_CONTRIB=$(shell echo "test_code");
@else
@ DLG_CONTRIB=$(shell echo `docker exec daliuge-engine /bin/bash -c 'printenv DLG_ROOT'`) && echo "Installation directory: $(DLG_CONTRIB)";
@fi;
@d=$(shell pwd);
@$(shell echo $(d));
@#scp -r ../$(b) $(DLG_CONTRIB); cd $(DLG_CONTRIB)/$(b) && $(ENV_PREFIX)pip install --upgrade -e .;
.PHONY: fmt
fmt: ## Format code using black & isort.
$(ENV_PREFIX)isort dlg_example_cmpts/
$(ENV_PREFIX)black -l 90 dlg_example_cmpts/
$(ENV_PREFIX)black -l 90 tests/
.PHONY: lint
lint: ## Run pep8, black, mypy linters.
$(ENV_PREFIX)flake8 -l 90 dlg_example_cmpts/
$(ENV_PREFIX)black -l 90 --check dlg_example_cmpts/
$(ENV_PREFIX)black -l 90 --check tests/
$(ENV_PREFIX)mypy --ignore-missing-imports dlg_example_cmpts/
.PHONY: test
test: lint ## Run tests and generate coverage report.
$(ENV_PREFIX)pytest -v --cov-config .coveragerc --cov=dlg_example_cmpts -l --tb=short --maxfail=1 tests/
$(ENV_PREFIX)coverage xml
$(ENV_PREFIX)coverage html
.PHONY: watch
watch: ## Run tests on every change.
ls **/**.py | entr $(ENV_PREFIX)pytest -s -vvv -l --tb=long --maxfail=1 tests/
.PHONY: clean
clean: ## Clean unused files.
@find ./ -name '*.pyc' -exec rm -f {} \;
@find ./ -name '__pycache__' -exec rm -rf {} \;
@find ./ -name 'Thumbs.db' -exec rm -f {} \;
@find ./ -name '*~' -exec rm -f {} \;
@rm -rf .cache
@rm -rf .pytest_cache
@rm -rf .mypy_cache
@rm -rf build
@rm -rf dist
@rm -rf *.egg-info
@rm -rf htmlcov
@rm -rf .tox/
@rm -rf docs/_build
.PHONY: virtualenv
virtualenv: ## Create a virtual environment.
@if [ "$(USING_POETRY)" ]; then poetry install && exit; fi
@echo "creating virtualenv ..."
@rm -rf .venv
@python3 -m venv .venv
@./.venv/bin/pip install -U pip
@./.venv/bin/pip install -e .[test]
@echo
@echo "!!! Please run 'source .venv/bin/activate' to enable the environment !!!"
.PHONY: release
release: ## Create a new tag for release.
@echo "WARNING: This operation will create s version tag and push to github"
@read -p "Version? (provide the next x.y.z semver) : " TAG
@echo "v$${TAG}" > dlg_example_cmpts/VERSION
@$(ENV_PREFIX)gitchangelog > HISTORY.md
@git add dlg_example_cmpts/VERSION HISTORY.md
@git commit -m "release: version v$${TAG} 🚀"
@echo "creating git tag : v$${TAG}"
@git tag v$${TAG}
@git push -u origin main --tags
@echo "Github Actions will detect the new tag and release the new version."
.PHONY: docs
docs: ## Build the documentation.
@echo "building documentation ..."
@$(ENV_PREFIX)mkdocs build
URL="site/index.html"; xdg-open $$URL || sensible-browser $$URL || x-www-browser $$URL || gnome-open $$URL
.PHONY: switch-to-poetry
switch-to-poetry: ## Switch to poetry package manager.
@echo "Switching to poetry ..."
@if ! poetry --version > /dev/null; then echo 'poetry is required, install from https://python-poetry.org/'; exit 1; fi
@rm -rf .venv
@poetry init --no-interaction --name=a_flask_test --author=ICRAR
@echo "" >> pyproject.toml
@echo "[tool.poetry.scripts]" >> pyproject.toml
@cat requirements.txt | while read in; do poetry add --no-interaction "$${in}"; done
@cat requirements-test.txt | while read in; do poetry add --no-interaction "$${in}" --dev; done
@poetry install --no-interaction
@mkdir -p .github/backup
@mv requirements* .github/backup
@mv setup.py .github/backup
@echo "You have switched to https://python-poetry.org/ package manager."
@echo "Please run 'poetry shell' or 'poetry run dlg_example_cmpts'"
.PHONY: init
init: ## Initialize the project based on an application template.
@./.github/init.sh
# This project has been generated from ICRAR/daliuge-component-template
# __author__ = 'ICRAR'
# __repo__ = https://github.com/ICRAR/daliuge-component-template
# __sponsor__ = https://github.com/sponsors/ICRAR/