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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
# Python settings
ifndef TRAVIS
ifndef PYTHON_MAJOR
PYTHON_MAJOR := 3
endif
ifndef PYTHON_MINOR
PYTHON_MINOR := 8
endif
ENV := env/py$(PYTHON_MAJOR)$(PYTHON_MINOR)
else
# Use the virtualenv provided by Travis
ENV = $(VIRTUAL_ENV)
endif
# Project settings
PROJECT := Flask-RESTful
PACKAGE := flask_restful
SOURCES := Makefile setup.py $(shell find $(PACKAGE) -name '*.py')
EGG_INFO := $(subst -,_,$(PROJECT)).egg-info
# System paths
PLATFORM := $(shell python -c 'import sys; print(sys.platform)')
ifneq ($(findstring win32, $(PLATFORM)), )
SYS_PYTHON_DIR := C:\\Python$(PYTHON_MAJOR)$(PYTHON_MINOR)
SYS_PYTHON := $(SYS_PYTHON_DIR)\\python.exe
SYS_VIRTUALENV := $(SYS_PYTHON_DIR)\\Scripts\\virtualenv.exe
else
SYS_PYTHON := python$(PYTHON_MAJOR)
ifdef PYTHON_MINOR
SYS_PYTHON := $(SYS_PYTHON).$(PYTHON_MINOR)
endif
SYS_VIRTUALENV := virtualenv
endif
# virtualenv paths
ifneq ($(findstring win32, $(PLATFORM)), )
BIN := $(ENV)/Scripts
OPEN := cmd /c start
else
BIN := $(ENV)/bin
ifneq ($(findstring cygwin, $(PLATFORM)), )
OPEN := cygstart
else
OPEN := open
endif
endif
# virtualenv executables
PYTHON := $(BIN)/python
PIP := $(BIN)/pip
FLAKE8 := $(BIN)/flake8
PEP8RADIUS := $(BIN)/pep8radius
PEP257 := $(BIN)/pep257
NOSE := $(BIN)/nosetests
COVERAGE := $(BIN)/coverage
ACTIVATE := $(BIN)/activate
# Remove if you don't want pip to cache downloads
PIP_CACHE_DIR := .cache
PIP_CACHE := --download-cache $(PIP_CACHE_DIR)
# Flags for PHONY targets
DEPENDS_TEST := $(ENV)/.depends-test
DEPENDS_DEV := $(ENV)/.depends-dev
DEPENDS_DOC := $(ENV)/.depends-doc
# Main Targets ###############################################################
.PHONY: all
all: test
# Targets to run on Travis
.PHONY: ci
ci: test
# Development Installation ###################################################
.PHONY: env
env: $(PIP)
$(PIP):
$(SYS_VIRTUALENV) --python $(SYS_PYTHON) $(ENV)
$(PIP) install wheel
.PHONY: depends
depends: .depends-test .depends-dev .depends-doc
.PHONY: .depends-test
.depends-test: env Makefile $(DEPENDS_TEST)
$(DEPENDS_TEST): Makefile tests/requirements.txt
$(PIP) install -e .
$(PIP) install -r tests/requirements.txt
touch $(DEPENDS_TEST) # flag to indicate dependencies are installed
.PHONY: .depends-dev
.depends-dev: env Makefile $(DEPENDS_DEV)
$(DEPENDS_DEV): Makefile
$(PIP) install $(PIP_CACHE) flake8 pep257 pep8radius
touch $(DEPENDS_DEV) # flag to indicate dependencies are installed
.PHONY: .depends-doc
.depends-doc: env Makefile setup.py $(DEPENDS_DOC)
$(DEPENDS_DOC): Makefile setup.py
$(PIP) install -e .[docs]
touch $(DEPENDS_DOC) # flag to indicate dependencies are installed
# Documentation ##############################################################
.PHONY: doc
doc: .depends-doc
. $(ACTIVATE); cd docs; $(MAKE) html
.PHONY: read
read: doc
$(OPEN) docs/_build/html/index.html
# Static Analysis ############################################################
.PHONY: check
check: flake8 pep257
PEP8_IGNORED := E501
.PHONY: flake8
flake8: .depends-dev
$(FLAKE8) $(PACKAGE) tests --ignore=$(PEP8_IGNORED)
.PHONY: pep257
pep257: .depends-dev
$(PEP257) $(PACKAGE)
.PHONY: fix
fix: .depends-dev
$(PEP8RADIUS) --docformatter --in-place
# Testing ####################################################################
.PHONY: test
test: .depends-test .clean-test
$(NOSE) tests --with-coverage --cover-package=$(PACKAGE)
test-all: test-py27 test-py34 test-py35 test-py36 test-py37 test-py38
test-py27:
PYTHON_MAJOR=2 PYTHON_MINOR=7 $(MAKE) test
test-py34:
PYTHON_MAJOR=3 PYTHON_MINOR=4 $(MAKE) test
test-py35:
PYTHON_MAJOR=3 PYTHON_MINOR=5 $(MAKE) test
test-py36:
PYTHON_MAJOR=3 PYTHON_MINOR=6 $(MAKE) test
test-py37:
PYTHON_MAJOR=3 PYTHON_MINOR=7 $(MAKE) test
test-py38:
PYTHON_MAJOR=3 PYTHON_MINOR=8 $(MAKE) test
.PHONY: htmlcov
htmlcov: test
$(COVERAGE) html
$(OPEN) htmlcov/index.html
# Cleanup ####################################################################
.PHONY: clean
clean: .clean-test
find $(PACKAGE) -name '*.pyc' -delete
find $(PACKAGE) -name '__pycache__' -delete
rm -rf dist build
rm -rf docs/_build
rm -rf $(EGG_INFO)
.PHONY: clean-all
clean-all: clean
rm -rf $(PIP_CACHE_DIR)
rm -rf $(ENV)
.PHONY: .clean-test
.clean-test:
rm -rf .coverage htmlcov
# Release ####################################################################
.PHONY: authors
authors:
echo "Authors\n=======\n\nA huge thanks to all of our contributors:\n\n" > AUTHORS.md
git log --raw | grep "^Author: " | cut -d ' ' -f2- | cut -d '<' -f1 | sed 's/^/- /' | sort | uniq >> AUTHORS.md
.PHONY: register
register: doc
$(PYTHON) setup.py register
.PHONY: dist
dist: doc test
$(PYTHON) setup.py sdist
$(PYTHON) setup.py bdist_wheel
.PHONY: upload
upload: doc register
$(PYTHON) setup.py sdist upload
$(PYTHON) setup.py bdist_wheel upload
|
