forked from aertslab/pycisTopic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
144 lines (100 loc) · 3.7 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
134
135
136
137
138
139
140
141
142
143
144
# This makefile has been created to help developers perform common actions.
# Most actions assume it is operating in a virtual environment where the
# python command links to the appropriate virtual environment Python.
MAKEFLAGS += --no-print-directory
# Do not remove this block. It is used by the 'help' rule when
# constructing the help output.
# help:
# help: pycisTopic Makefile help
# help:
# help: help - display this makefile's help information
.PHONY: help
help:
@grep "^# help\:" Makefile | grep -v grep | sed 's/\# help\: //' | sed 's/\# help\://'
# help: venv - create a virtual environment for development
.PHONY: venv
venv:
@rm -Rf venv
@python3 -m venv venv --prompt pycisTopic
@/bin/bash -c "source venv/bin/activate && pip install pip --upgrade && pip install -r requirements.dev.txt && pip install -e ."
@echo -e "Enter virtual environment using:\n\n\t$ source venv/bin/activate\n"
# help: clean - clean all files using .gitignore rules
.PHONY: clean
clean:
@git clean -X -f -d
# help: scrub - clean all files, even untracked files
.PHONY: scrub
scrub:
git clean -x -f -d
# help: test - run tests
.PHONY: test
test:
@pytest
# help: coverage - perform test coverage checks
.PHONY: coverage
coverage:
@coverage erase
@PYTHONPATH=src coverage run -m pytest
@coverage html
@coverage report
# help: format - perform code style format
.PHONY: format
format:
@black -S pycisTopic tests
# help: check-format - check code format compliance
.PHONY: check-format
check-format:
@black -S --check pycisTopic tests
# help: sort-imports - apply import sort ordering
.PHONY: sort-imports
sort-imports:
@isort . --profile black
# help: check-sort-imports - check imports are sorted
.PHONY: check-sort-imports
check-sort-imports:
@isort . --check-only --profile black
# help: style - perform code style format
.PHONY: style
style: sort-imports format
# help: check-style - check code style compliance
.PHONY: check-style
check-style: check-sort-imports check-format
# help: check-types - check type hint annotations
.PHONY: check-types
check-types:
@cd src; mypy -p pycisTopic --ignore-missing-imports
# help: check-lint - run static analysis checks
.PHONY: check-lint
check-lint:
@pylint --rcfile=.pylintrc pycisTopic ./tests setup.py
# help: check-static-analysis - check code style compliance
.PHONY: check-static-analysis
check-static-analysis: check-lint check-types
# help: docs - generate project documentation
.PHONY: docs
docs: coverage
@cd docs; rm -rf source/api/pycisTopic*.rst source/api/modules.rst build/*
@cd docs; make html
# help: check-docs - quick check docs consistency
.PHONY: check-docs
check-docs:
@cd docs; make dummy
# help: serve-docs - serve project html documentation
.PHONY: serve-docs
serve-docs:
@cd docs/build; python -m http.server --bind 127.0.0.1
# help: dist - create a wheel distribution package
.PHONY: dist
dist:
@python setup.py bdist_wheel
# help: dist-test - test a whell distribution package
.PHONY: dist-test
dist-test: dist
@cd dist && ../tests/test-dist.bash ./pycisTopic-*-py3-none-any.whl
# help: dist-upload - upload a wheel distribution package
.PHONY: dist-upload
dist-upload:
@twine upload dist/pycisTopic-*-py3-none-any.whl
# Keep these lines at the end of the file to retain nice help
# output formatting.
# help: