forked from cis-ds/course-site
-
Notifications
You must be signed in to change notification settings - Fork 0
/
git06.html
332 lines (280 loc) · 11.3 KB
/
git06.html
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
320
321
322
323
324
325
326
327
328
329
330
331
332
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="pandoc" />
<title>Using Git with Python and Jupyter Notebooks</title>
<script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/readable.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-45631879-2', 'auto');
ga('send', 'pageview');
</script>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
div.sourceCode { overflow-x: auto; }
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
</style>
<style type="text/css">
pre:not([class]) {
background-color: white;
}
</style>
<style type="text/css">
h1 {
font-size: 34px;
}
h1.title {
font-size: 38px;
}
h2 {
font-size: 30px;
}
h3 {
font-size: 24px;
}
h4 {
font-size: 18px;
}
h5 {
font-size: 16px;
}
h6 {
font-size: 12px;
}
.table th:not([align]) {
text-align: left;
}
</style>
</head>
<body>
<style type = "text/css">
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
code {
color: inherit;
background-color: rgba(0, 0, 0, 0.04);
}
img {
max-width:100%;
height: auto;
}
.tabbed-pane {
padding-top: 12px;
}
button.code-folding-btn:focus {
outline: none;
}
</style>
<style type="text/css">
/* padding for bootstrap navbar */
body {
padding-top: 66px;
padding-bottom: 40px;
}
/* offset scroll position for anchor links (for fixed navbar) */
.section h1 {
padding-top: 71px;
margin-top: -71px;
}
.section h2 {
padding-top: 71px;
margin-top: -71px;
}
.section h3 {
padding-top: 71px;
margin-top: -71px;
}
.section h4 {
padding-top: 71px;
margin-top: -71px;
}
.section h5 {
padding-top: 71px;
margin-top: -71px;
}
.section h6 {
padding-top: 71px;
margin-top: -71px;
}
</style>
<script>
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark it active
menuAnchor.parent().addClass('active');
// if it's got a parent navbar menu mark it active as well
menuAnchor.closest('li.dropdown').addClass('active');
});
</script>
<div class="container-fluid main-container">
<!-- tabsets -->
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<script>
$(document).ready(function () {
window.buildTabsets("TOC");
});
</script>
<!-- code folding -->
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Computing for the Social Sciences</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">Home</a>
</li>
<li>
<a href="faq.html">FAQ</a>
</li>
<li>
<a href="syllabus.html">Syllabus</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div class="fluid-row" id="header">
<h1 class="title toc-ignore">Using Git with Python and Jupyter Notebooks</h1>
</div>
<div id="TOC">
<ul>
<li><a href="#git-and-python">Git and Python</a></li>
<li><a href="#git-and-jupyter-notebooks">Git and Jupyter Notebooks</a></li>
</ul>
</div>
<div id="git-and-python" class="section level1">
<h1>Git and Python</h1>
<p>The short answer is that Git works with Python just as well as R. In fact, you can use RStudio as a Python IDE to edit and run Python (<code>.py</code>) scripts. That said, there are plenty of IDEs specifically for Python that have Git integrated. Otherwise, the fallback option is to use Git from the <a href="shell.html">shell</a> or whatever <a href="git02.html">Git client you chose to install</a>.</p>
</div>
<div id="git-and-jupyter-notebooks" class="section level1">
<h1>Git and Jupyter Notebooks</h1>
<p>Jupyter Notebooks present a more tricky challenge to tracking and syncing with Git. Jupyter Notebooks can be committed and synced with a GitHub repo. In fact, <a href="https://github.com/blog/1995-github-jupyter-notebooks-3">GitHub will render your notebook directly on your GitHub repo page</a>.</p>
<p>The main issue comes in how Jupyter Notebooks store their content. What you see in the Notebook Viewer is the rendered copy of the notebook. The actual notebook looks something like this:</p>
<div class="sourceCode"><pre class="sourceCode python"><code class="sourceCode python">{
<span class="st">"cells"</span>: [
{
<span class="st">"cell_type"</span>: <span class="st">"code"</span>,
<span class="co">"execution_count"</span>: <span class="dv">1</span>,
<span class="co">"metadata"</span>: {
<span class="st">"collapsed"</span>: false
},
<span class="co">"outputs"</span>: [
{
<span class="st">"name"</span>: <span class="st">"stdout"</span>,
<span class="co">"output_type"</span>: <span class="st">"stream"</span>,
<span class="co">"text"</span>: [
<span class="st">"Hello world</span><span class="ch">\n</span><span class="st">"</span>
]
}
],
<span class="co">"source"</span>: [
<span class="st">"print('Hello world')"</span>
]
}
],
<span class="co">"metadata"</span>: {
<span class="st">"anaconda-cloud"</span>: {},
<span class="co">"kernelspec"</span>: {
<span class="st">"display_name"</span>: <span class="st">"Python [Root]"</span>,
<span class="co">"language"</span>: <span class="st">"python"</span>,
<span class="co">"name"</span>: <span class="st">"Python [Root]"</span>
},
<span class="co">"language_info"</span>: {
<span class="st">"codemirror_mode"</span>: {
<span class="st">"name"</span>: <span class="st">"ipython"</span>,
<span class="co">"version"</span>: <span class="dv">3</span>
},
<span class="co">"file_extension"</span>: <span class="st">".py"</span>,
<span class="co">"mimetype"</span>: <span class="st">"text/x-python"</span>,
<span class="co">"name"</span>: <span class="st">"python"</span>,
<span class="co">"nbconvert_exporter"</span>: <span class="st">"python"</span>,
<span class="co">"pygments_lexer"</span>: <span class="st">"ipython3"</span>,
<span class="co">"version"</span>: <span class="st">"3.5.2"</span>
}
},
<span class="co">"nbformat"</span>: <span class="dv">4</span>,
<span class="co">"nbformat_minor"</span>: <span class="dv">0</span>
}</code></pre></div>
<p>Jupyter Notebooks don’t store their data as a plain-text file, but instead in this structured format. This is fine when it comes to storing and tracking code, but the notebook also includes all output. Sometimes you want to track changes to your code without storing all the output as well.</p>
<p>If that is the case, there are <a href="https://www.google.com/search?q=git+and+jupyter+notebooks">methods for stripping the output from a Jupyter Notebook and only committing changes to the code</a>. However these methods are beyond the requirements of this course. In the future you might want to explore these options. However for this course I recommend you simply track all changes, including code and output. Because there is no integration of Git within the Jupyter Notebook server, you will need to use your Git client or the shell to stage, commit, and sync changes.</p>
</div>
<p>This work is licensed under the <a href="http://creativecommons.org/licenses/by-nc/4.0/">CC BY-NC 4.0 Creative Commons License</a>.</p>
</div>
<script>
// add bootstrap table styles to pandoc tables
$(document).ready(function () {
$('tr.header').parent('thead').parent('table').addClass('table table-condensed');
});
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>