forked from ucla-data-science-center/ucla-data-archive_old
-
Notifications
You must be signed in to change notification settings - Fork 0
/
fabfile.py
319 lines (248 loc) · 10.7 KB
/
fabfile.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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
import re
import json
import sys
import shlex
import subprocess as sp
from pathlib import Path
from datetime import datetime
from collections import defaultdict
from typing import *
import nbformat
from nbconvert import MarkdownExporter
from nbconvert.preprocessors import Preprocessor
from traitlets.config import Config
from watchdog.events import PatternMatchingEventHandler
from watchdog.observers import Observer
import crayons
from fabric.api import *
@task
def render_notebooks():
"""
Render jupyter notebooks it notebooks directory to respective markdown in content/post directory.
"""
notebooks = Path('notebooks').glob('*.ipynb')
for notebook in notebooks:
if (not str(notebook).startswith('.')) and ('untitled' not in str(notebook).lower()):
update_notebook_metadata(notebook)
write_hugo_formatted_nb_to_md(notebook)
@task
def serve(hugo_args='', init_jupyter=True):
"""
Watch for changes in jupyter notebooks and render them anew while hugo runs.
Args:
init_jupyter: initialize jupyter if set to True
hugo_args: command-line arguments to be passed to `hugo server`
"""
observer = Observer()
observer.schedule(NotebookHandler(), 'notebooks')
observer.start()
hugo_process = sp.Popen(('hugo', 'serve', *shlex.split(hugo_args)))
if init_jupyter:
jupyter_process = sp.Popen(('jupyter', 'notebook'), cwd='notebooks')
local('open http://localhost:1313')
try:
print(crayons.green('Successfully initialized server(s)'),
crayons.yellow('press ctrl+C at any time to quit'),
)
while True:
pass
except KeyboardInterrupt:
print(crayons.yellow('Terminating'))
finally:
if init_jupyter:
print(crayons.yellow('shutting down jupyter'))
jupyter_process.kill()
print(crayons.yellow('shutting down watchdog'))
observer.stop()
observer.join()
print(crayons.yellow('shutting down hugo'))
hugo_process.kill()
print(crayons.green('all processes shut down successfully'))
sys.exit(0)
@task
def publish():
"""
Publish notebook to github pages.
Assumes this is yourusername.github.io repo aka
User Pages site as described in
https://help.github.com/articles/user-organization-and-project-pages/
and that you're using the master branch only
to have the rendered content of your blog.
"""
with settings(warn_only=True):
if local('git diff-index --quiet HEAD --').failed:
local('git status')
abort('The working directory is dirty. Please commit any pending changes.')
# deleting old publication
local('rm -rf public')
local('mkdir public')
local('git worktree prune')
local('rm -rf .git/worktrees/public/')
# checkout out gh-pages branch into public
local('git worktree add -B master public upstream/master')
# removing any existing files
local('rm -rf public/*')
# generating site
render_notebooks()
local('hugo')
# commit
with lcd('public'), settings(warn_only=True):
local('git add .')
local('git commit -m "Committing to master (Fabfile)"')
# push to master
local('git push upstream master')
print('push succeeded')
########## Jupyter stuff #################
class CustomPreprocessor(Preprocessor):
"""Remove blank code cells and unnecessary whitespace."""
def preprocess(self, nb, resources):
"""
Remove blank cells
"""
for index, cell in enumerate(nb.cells):
if cell.cell_type == 'code' and not cell.source:
nb.cells.pop(index)
else:
nb.cells[index], resources = self.preprocess_cell(cell, resources, index)
return nb, resources
def preprocess_cell(self, cell, resources, cell_index):
"""
Remove extraneous whitespace from code cells' source code
"""
if cell.cell_type == 'code':
cell.source = cell.source.strip()
return cell, resources
def doctor(string: str) -> str:
"""Get rid of all the wacky newlines nbconvert adds to markdown output and return result."""
post_code_newlines_patt = re.compile(r'(```)(\n+)')
inter_output_newlines_patt = re.compile(r'(\s{4}\S+)(\n+)(\s{4})')
post_code_filtered = re.sub(post_code_newlines_patt, r'\1\n\n', string)
inter_output_filtered = re.sub(inter_output_newlines_patt, r'\1\n\3', post_code_filtered)
return inter_output_filtered
def notebook_to_markdown(path: Union[Path, str]) -> str:
"""
Convert jupyter notebook to hugo-formatted markdown string
Args:
path: path to notebook
Returns: hugo-formatted markdown
"""
with open(Path(path)) as fp:
notebook = nbformat.read(fp, as_version=4)
assert 'front-matter' in notebook['metadata'], "You must have a front-matter field in the notebook's metadata"
front_matter_dict = dict(notebook['metadata']['front-matter'])
front_matter = json.dumps(front_matter_dict, indent=2)
c = Config()
c.MarkdownExporter.preprocessors = [CustomPreprocessor]
markdown_exporter = MarkdownExporter(config=c)
markdown, _ = markdown_exporter.from_notebook_node(notebook)
doctored_md = doctor(markdown)
# added <!--more--> comment to prevent summary creation
output = '\n'.join(('---', front_matter, '---', '<!--more-->', doctored_md))
return output
def write_hugo_formatted_nb_to_md(notebook: Union[Path, str], render_to: Optional[Union[Path, str]] = None) -> Path:
"""
Convert Jupyter notebook to markdown and write it to the appropriate file.
Args:
notebook: The path to the notebook to be rendered
render_to: The directory we want to render the notebook to
"""
notebook = Path(notebook)
notebook_metadata = json.loads(notebook.read_text())['metadata']
rendered_markdown_string = notebook_to_markdown(notebook)
slug = notebook_metadata['front-matter']['slug']
render_to = render_to or notebook_metadata['hugo-jupyter']['render-to'] or 'content/post/'
if not render_to.endswith('/'):
render_to += '/'
rendered_markdown_file = Path(render_to, slug + '.md')
if not rendered_markdown_file.parent.exists():
rendered_markdown_file.parent.mkdir(parents=True)
rendered_markdown_file.write_text(rendered_markdown_string)
print(notebook.name, '->', rendered_markdown_file.name)
return rendered_markdown_file
def update_notebook_metadata(notebook: Union[Path, str],
title: Union[None, str] = None,
subtitle: Union[None, str] = None,
date: Union[None, str] = None,
slug: Union[None, str] = None,
render_to: str = None):
"""
Update the notebook's metadata for hugo rendering
Args:
notebook: notebook to have edited
"""
notebook_path: Path = Path(notebook)
notebook_data: dict = json.loads(notebook_path.read_text())
old_front_matter: dict = notebook_data.get('metadata', {}).get('front-matter', {})
# generate front-matter fields
title = title or old_front_matter.get('title') or notebook_path.stem
subtitle = subtitle or old_front_matter.get('subtitle') or 'Generic subtitle'
date = date or old_front_matter.get('date') or datetime.now().strftime('%Y-%m-%d')
slug = slug or old_front_matter.get('slug') or title.lower().replace(' ', '-')
front_matter = {
'title': title,
'subtitle': subtitle,
'date': date,
'slug': slug,
}
# update front-matter
notebook_data['metadata']['front-matter'] = front_matter
# update hugo-jupyter settings
render_to = render_to or notebook_data['metadata'].get('hugo-jupyter', {}).get('render-to') or 'content/post/'
hugo_jupyter = {
'render-to': render_to
}
notebook_data['metadata']['hugo-jupyter'] = hugo_jupyter
# write over old notebook with new front-matter
notebook_path.write_text(json.dumps(notebook_data))
# make the notebook trusted again, now that we've changed it
sp.run(['jupyter', 'trust', str(notebook_path)])
########## Watchdog stuff #################
class NotebookHandler(PatternMatchingEventHandler):
patterns = ["*.ipynb"]
def __init__(self, *args, **kwargs):
super().__init__(self, *args, **kwargs)
# a mapping of notebook filepaths and their respective metadata
self.notebook_metadata: Mapping[str, dict] = {}
# a mapping of notebook filepaths and where they were rendered to
self.notebook_render: Mapping[str, List[Path]] = defaultdict(list)
def process(self, event):
# update filename_slug dictionary
self.update_notebook_metadata_registry(event)
try:
# don't automatically update front matter
# and render notebook until filename is
# changed from untitled...
if 'untitled' not in event.src_path.lower() and not event.src_path.startswith('.'):
self.delete_notebook_md(event)
update_notebook_metadata(event.src_path)
render_to = self.get_render_to_field(event)
rendered = write_hugo_formatted_nb_to_md(event.src_path, render_to=render_to)
self.notebook_render[event.src_path].append(rendered)
except Exception as e:
print('could not successfully render', event.src_path)
print(e)
def on_modified(self, event):
self.process(event)
def on_created(self, event):
self.process(event)
def on_deleted(self, event):
self.delete_notebook_md(event)
def delete_notebook_md(self, event):
print(crayons.yellow("attempting to delete the post for {}".format(event.src_path)))
for path in self.notebook_render[event.src_path]:
if path.exists():
path.unlink()
print(crayons.yellow('removed post: {}'.format(path)))
def update_notebook_metadata_registry(self, event):
try:
self.notebook_metadata[event.src_path] = json.loads(
Path(event.src_path).read_text())['metadata']
except json.JSONDecodeError:
print(crayons.yellow("Could not decode as json file: {}".format(event.src_path)))
def get_render_to_field(self, event) -> Optional[Path]:
try:
return self.notebook_metadata[event.src_path].get('hugo-jupyter', {}).get('render-to')
except json.JSONDecodeError:
print(crayons.yellow("could not marshal notebook to json: {}".format(event.src_path)))
except KeyError:
print("{} has no field hugo-jupyter.render-to in its metadata".format(event.src_path))