-
Notifications
You must be signed in to change notification settings - Fork 2
/
bootstrap.py
executable file
·224 lines (181 loc) · 9.01 KB
/
bootstrap.py
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
#!/usr/bin/env python3
"""
Copyright (c) 2022 Gino Latorilla. All rights reserved.
"""
import argparse
import logging
import os
import shlex
import shutil
import subprocess
import sys
from pathlib import Path
from string import Template
from tempfile import mkdtemp
from typing import Any, Dict, Tuple
import venv
APP_NAME = Path(sys.argv[0]).stem
log = logging.getLogger(APP_NAME)
def main() -> int:
program_options = make_cl_argument_parser().parse_args()
setup_logger(program_options.verbosity)
if program_options.dev:
local_project_dir = Path(__file__).parent
log.info(f'Setting up project for development mode ({local_project_dir.absolute()})')
log.debug('The following command line arguments will be ignored:')
log.debug(' --project')
log.debug(' --directory')
log.debug(' --layout')
log.debug('Generating pyproject.toml.')
with open(local_project_dir / 'pyproject.toml.template', 'r') as fp:
pyproject_template = Template(fp.read())
with open(local_project_dir / 'pyproject.toml', 'w') as fp:
fp.write(pyproject_template.safe_substitute(project_name='yourproject'))
log.info('Re-initialising project directory: virtual environment and Git')
log.debug('Creating virtual environment.')
venv_dir = Path('.venv')
venv.create(venv_dir.absolute(), with_pip=True)
subprocess.run([(venv_dir / 'bin/python').absolute(), *shlex.split('-m pip install --upgrade pip')])
log.debug('Installing project as editable package.')
subprocess.run([(venv_dir / 'bin/python').absolute(), *shlex.split('-m pip install --editable .[dev]')])
log.info('Congratulations, you may now develop in this project')
log.info('Make sure to run the following afterwards:')
log.info(f' source {venv_dir / "bin/activate"}')
log.info('(Or whichever activation script is there for your shell.)')
return 0
else:
if not program_options.project.isidentifier():
log.error(f'{program_options.project} is not a valid Python identifier.')
return 1
new_project_root: Path = Path(program_options.destination) / program_options.project
if new_project_root.exists():
log.error(f'The project destination directory exists: {new_project_root.absolute()}.')
return 1
if os.getenv('VIRTUAL_ENV') is not None:
log.error(
'Cannot continue while inside an active Virtual Environment. Did you forget to call "deactivate"?')
return 1
log.info(f'Preparing new project root directory in: {new_project_root.absolute()}')
staging_directory = Path(mkdtemp())
log.debug(f'We have created a temporary staging directory here: {staging_directory.absolute()}')
log.debug(f'Copying project tree to: {staging_directory.absolute()}')
shutil.copytree(src=Path(__file__).parent, dst=staging_directory, dirs_exist_ok=True)
log.debug('Removing files that are ignored or not tracked by Git.')
subprocess.run(shlex.split(f'git -C "{staging_directory}" clean -ffxd'), stdout=subprocess.DEVNULL)
log.debug('Removing files that are used by Git.')
for path in staging_directory.glob('.git'):
path.unlink() if path.is_file() else shutil.rmtree(path)
log.debug('Removing the copy of this bootstrapping script.')
(staging_directory / 'bootstrap.py').unlink()
if program_options.layout == 'module':
log.debug('Removing the package directory because you chose "module" as the project layout.')
shutil.rmtree(staging_directory / 'src')
log.debug(f'Renaming the module to {program_options.project}.py.')
(staging_directory / 'yourproject.py').rename(staging_directory / f'{program_options.project}.py')
else:
log.debug('Removing the module file because you chose "package" as the project layout.')
(staging_directory / 'yourproject.py').unlink()
log.debug(f'Renaming the package directory to {program_options.project}/.')
(staging_directory / 'src/yourproject').rename(staging_directory / f'src/{program_options.project}')
log.debug('Generating pyproject.toml.')
with open(staging_directory / 'pyproject.toml.template', 'r') as fp:
pyproject_template = Template(fp.read())
log.debug('Removing pyproject.toml.template.')
(staging_directory / 'pyproject.toml.template').unlink()
with open(staging_directory / 'pyproject.toml', 'w') as fp:
fp.write(pyproject_template.safe_substitute(project_name=program_options.project))
log.debug('Removing pyproject.toml in .gitignore.')
with open(staging_directory / '.gitignore', 'r+') as fp:
lines = [line for line in fp if 'pyproject.toml' not in line]
fp.seek(0)
fp.writelines(lines)
fp.truncate()
log.debug(f'Moving staging directory to destination: {new_project_root.absolute()}')
new_project_root.mkdir(parents=True, exist_ok=True)
staging_directory.rename(new_project_root)
log.info('Re-initialising project directory: virtual environment and Git')
log.debug('Creating virtual environment.')
venv_dir = new_project_root / '.venv'
venv.create(venv_dir.absolute(), with_pip=True)
subprocess.run([(venv_dir / 'bin/python').absolute(), *shlex.split('-m pip install --upgrade pip')])
log.debug('Installing project as editable package.')
subprocess.run([(venv_dir / 'bin/python').absolute(), *shlex.split('-m pip install --editable .[dev]')],
cwd=new_project_root)
log.debug('Running all tests.')
subprocess.run([(venv_dir / 'bin/python').absolute(), *shlex.split('-m mypy .')], cwd=new_project_root)
subprocess.run([(venv_dir / 'bin/python').absolute(), *shlex.split('-m flake8 .')], cwd=new_project_root)
subprocess.run([(venv_dir / 'bin/python').absolute(), *shlex.split('-m pytest --no-cov')],
cwd=new_project_root)
log.debug('Re-initialising Git repository')
subprocess.run(shlex.split(f'git -C {new_project_root} init'))
log.info(f'Congratulations, you may now work in your new project at: {new_project_root.absolute()}')
log.info('Make sure to do the following afterwards:')
log.info(' 1. Update docstrings in every new *.py file.')
log.info(' 2. Update all "TODO" bits in pyproject.toml.')
log.info(' 3. Change LICENSE, if necessary.')
log.info(' 4. Update the README.md.')
os.chdir(new_project_root.absolute())
return 0
def make_cl_argument_parser() -> argparse.ArgumentParser:
arguments_spec: Dict[Tuple[str, ...], Any] = {
('--project', ): {
'help': 'The name of your project.',
'default': 'yourproject'
},
('--dev', ): {
'help': 'Prepares this project for development mode.',
'action': 'store_true',
},
('-d', '--destination'): {
'help': 'Create project root in this directory.',
'default': str(Path('.').absolute()),
},
('-v', '--verbose'): {
'help': 'Increase logging verbosity. Can be specified multiple times.',
'action': 'count',
'default': 0,
'dest': 'verbosity'
},
('-l', '--layout'): {
'help': '"module": The project will be a single Python module. '
'"package": The project will be a package (a directory with __init__.py)',
'choices': {'module', 'package'},
'default': 'module'
},
}
class CustomFormatter(argparse.RawDescriptionHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
pass
ap = argparse.ArgumentParser(description=__doc__, formatter_class=CustomFormatter)
for args, kwargs in arguments_spec.items():
ap.add_argument(*args, **kwargs)
return ap
def setup_logger(verbosity: int) -> None:
assert verbosity >= 0
log_levels = {
0: {
'global': logging.WARNING,
'local': logging.INFO
},
1: {
'global': logging.WARNING,
'local': logging.DEBUG
},
2: {
'global': logging.INFO,
'local': logging.DEBUG
},
}.get(verbosity, {
'global': logging.DEBUG,
'local': logging.DEBUG
})
log_format = {
0: '[{levelname}] {name}: {message}',
1: '[{levelname}] {name}: {message}',
2: '<{asctime}> [{levelname}] {name}: {message}',
3: '<{asctime}> [{levelname}] [pid={process}] {name}: {message}',
}.get(verbosity, '<{asctime}> [{levelname}] [pid={process}] [tid={thread}] {name}({pathname}:{lineno}): {message}')
logging.basicConfig(level=log_levels['global'], style='{', format=log_format)
log.setLevel(log_levels['local'])
log.debug(f'Log level is {verbosity}.')
if __name__ == '__main__':
sys.exit(main())