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
|
"""dodo file. test + management stuff"""
import glob
import os
import subprocess
import pytest
from doitpy.pyflakes import Pyflakes
from doitpy.coverage import Config, Coverage, PythonPackage
from doit.tools import create_folder
DOIT_CONFIG = {
'minversion': '0.24.dev0',
'default_tasks': ['pyflakes', 'ut'],
# 'backend': 'sqlite3',
}
CODE_FILES = glob.glob("doit/*.py")
TEST_FILES = glob.glob("tests/test_*.py")
TESTING_FILES = glob.glob("tests/*.py")
PY_FILES = CODE_FILES + TESTING_FILES
def task_pyflakes():
flaker = Pyflakes()
yield flaker.tasks('doit/*.py')
yield flaker.tasks('tests/*.py')
def run_test(test):
return not bool(pytest.main(test))
#return not bool(pytest.main("-v " + test))
def task_ut():
"""run unit-tests"""
for test in TEST_FILES:
yield {'name': test,
'actions': [(run_test, (test,))],
'file_dep': PY_FILES,
'verbosity': 0}
################## coverage tasks
def task_coverage():
"""show coverage for all modules including tests"""
cov = Coverage([PythonPackage('doit', 'tests')],
config=Config(branch=False, parallel=True,
omit=['tests/myecho.py', 'tests/sample_process.py'],)
)
yield cov.all()
yield cov.src()
yield cov.by_module()
############################ website
DOC_ROOT = 'doc/'
DOC_BUILD_PATH = DOC_ROOT + '_build/html/'
def task_epydoc():
"""# generate API docs"""
target_path = DOC_BUILD_PATH + 'api/'
return {'actions':[(create_folder, [target_path]),
("epydoc --config %sepydoc.config " % DOC_ROOT +
"-o %(targets)s")],
'file_dep': CODE_FILES,
'targets': [target_path]}
def task_spell():
"""spell checker for doc files"""
# spell always return successful code (0)
# so this checks if the output is empty
def check_no_output(doc_file):
# -l list misspelled words
# -p set path of personal dictionary
cmd = 'hunspell -l -d en_US -p doc/dictionary.txt %s'
output = subprocess.check_output(cmd % doc_file, shell=True)
if len(output) != 0:
print(output)
return False
for doc_file in glob.glob('doc/*.rst') + ['README.rst']:
yield {
'name': doc_file,
'actions': [(check_no_output, (doc_file,))],
'file_dep': ['doc/dictionary.txt', doc_file],
'verbosity': 2,
}
def task_sphinx():
"""generate website docs (include analytics)"""
action = "sphinx-build -b html %s -d %s_build/doctrees %s %s"
opts = "-A include_analytics=1 -A include_gittip=1"
return {
'actions': [action % (opts, DOC_ROOT, DOC_ROOT, DOC_BUILD_PATH)],
'verbosity': 2,
'task_dep': ['spell'],
}
def task_website():
"""dodo file create website html files"""
return {'actions': None,
'task_dep': ['epydoc', 'sphinx'],
}
def task_website_update():
"""update website on SITE_PATH
website is hosted on github-pages
this task just copy the generated content to SITE_PATH,
need to commit/push to deploy site.
"""
SITE_PATH = '../doit-website'
SITE_URL = 'pydoit.org'
return {
'actions': [
"rsync -avP %s %s" % (DOC_BUILD_PATH, SITE_PATH),
"echo %s > %s" % (SITE_URL, os.path.join(SITE_PATH, 'CNAME')),
"touch %s" % os.path.join(SITE_PATH, '.nojekyll'),
],
'task_dep': ['website'],
}
################### dist
def task_revision():
"""create file with repo rev number"""
return {'actions': ["hg tip --template '{rev}:{node}' > revision.txt"]}
def task_manifest():
"""create manifest file for distutils """
def check_version():
# using a MANIFEST file directly is broken on python2.7
# http://bugs.python.org/issue11104
import sys
assert sys.version_info < (2,7) or sys.version_info > (2,7,2)
# create manifest will all files under version control without .hg* files
cmd = """hg manifest | grep -vE ".*\.hg.*" > MANIFEST """
cmd2 = "echo 'revision.txt' >> MANIFEST"
return {'actions': [check_version, cmd, cmd2]}
def task_sdist():
"""create source dist package"""
return {'actions': ["python setup.py sdist"],
'task_dep': ['revision', 'manifest'],
}
def task_pypi():
"""upload package to pypi"""
return {'actions': ["python setup.py sdist upload"],
'task_dep': ['revision', 'manifest'],
}
# doit -f ../doit-recipes/deps/deps.py -d . --reporter=executed-only
|
