-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsetup.html
405 lines (192 loc) · 13.9 KB
/
setup.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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Setting up your Environment · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.2">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="plug-intro.html" />
<link rel="prev" href="segments/learning/5-rs.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Overview
</a>
</li>
<li class="chapter " data-level="1.2" data-path="learning-tips.html">
<a href="learning-tips.html">
Learning Tips
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="segments/learning/learning-plan.html">
<a href="segments/learning/learning-plan.html">
Make a learning plan
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="segments/learning/5-rs.html">
<a href="segments/learning/5-rs.html">
The 5 Rs
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="setup.html">
<a href="setup.html#setting-up-your-environment">
Setting up your Environment
</a>
</li>
<li class="chapter " data-level="1.4" data-path="plug-intro.html">
<a href="plug-intro.html">
An introduction to Plug
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="plug-intro.html">
<a href="plug-intro.html#quickstart">
Quickstart
</a>
</li>
<li class="chapter " data-level="1.4.2" data-path="plug-intro.html">
<a href="plug-intro.html#balance-tutorial">
Balance Tutorial
</a>
</li>
<li class="chapter " data-level="1.4.3" data-path="segments/challenges/free-money-overview.html">
<a href="segments/challenges/free-money-overview.html">
Free Money Challenge
</a>
</li>
<li class="chapter " data-level="1.4.4" data-path="segments/challenges/free-money-solution.html">
<a href="segments/challenges/free-money-solution.html">
Free Money Sample Solution
</a>
</li>
<li class="chapter " data-level="1.4.5" data-path="plug-intro.html">
<a href="plug-intro.html#decide-what-to-do-next">
Next Steps
</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Setting up your Environment</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="setting-up-your-environment">Setting up your Environment</h1>
<p>Setting up your development environment can sometimes be painful. If you get stuck try and find someone in the slack group with the same system as you and ask for help.</p>
<h2 id="index">Index</h2>
<ul>
<li><a href="setup.html#python-36-or-later">Python 3</a></li>
<li><a href="setup.html#virtual-environment">Virtual Environment</a></li>
<li><a href="setup.html#download-the-plug-libraries">Plug Libraries</a></li>
</ul>
<h2 id="python-36-or-later">Python 3.6 or later</h2>
<p>You can verify which version of Python is installed by running the following command:</p>
<pre><code class="lang-sh">$ python --version
Python 3.6.4
</code></pre>
<p>If the version number is less than 3.6 (for example, if you see Python 2.7.14), then you will first need to install a newer version of Python.</p>
<p>Install Guides:</p>
<ul>
<li><a href="https://docs.python-guide.org/starting/install3/linux/" target="_blank">Linux</a></li>
<li><a href="https://docs.python-guide.org/starting/install3/osx/" target="_blank">OSX</a></li>
<li><a href="https://docs.python-guide.org/starting/install3/win/" target="_blank">Windows</a></li>
</ul>
<h2 id="virtual-environment">Virtual Environment</h2>
<p>Pipenv is a tool for isolating your Python and project libraries.</p>
<p>Before you install python libraries for your project it is highly recommended that you create/activate a virtual environment.</p>
<p>You can use pip to install pipenv</p>
<pre><code class="lang-sh">pip install --user pipenv
</code></pre>
<p>Note: if you are on a mac user then we recommend using homebrew to install pipenv - <code>brew install pipenv</code>.</p>
<p>See <a href="https://docs.python-guide.org/dev/virtualenvs/" target="_blank">Python Environment Guide</a> for a guide to using pipenv.</p>
<p>Once you have everything you need you can activate your environment.</p>
<pre><code class="lang-sh">pipenv shell
</code></pre>
<p>You will know that the virtual environment is active because the name of the virtual environment will be prepended to the shell prompt, e.g.:</p>
<pre><code class="lang-sh">(directory-name)$
</code></pre>
<p>Note, if you are vim user you might find some issues with using vim inside of your pipenv shell.</p>
<h2 id="download-the-plug-libraries">Download the plug libraries</h2>
<p>Next you will need to install the Plug libraries which you can download from the following git repo.</p>
<pre><code class="lang-sh">git <span class="hljs-built_in">clone</span> https://github.com/dev-academy-programme/plug-libs
</code></pre>
<p>The rest of the instructions will assume that the plug-libs folder is at the same level as your project.</p>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="segments/learning/5-rs.html" class="navigation navigation-prev " aria-label="Previous page: The 5 Rs">
<i class="fa fa-angle-left"></i>
</a>
<a href="plug-intro.html" class="navigation navigation-next " aria-label="Next page: An introduction to Plug">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Setting up your Environment","level":"1.3","depth":1,"next":{"title":"An introduction to Plug","level":"1.4","depth":1,"path":"plug-intro.md","ref":"plug-intro.md","articles":[{"title":"Quickstart","level":"1.4.1","depth":2,"anchor":"#quickstart","path":"plug-intro.md","ref":"plug-intro.md#quickstart","articles":[]},{"title":"Balance Tutorial","level":"1.4.2","depth":2,"anchor":"#balance-tutorial","path":"plug-intro.md","ref":"plug-intro.md#balance-tutorial","articles":[]},{"title":"Free Money Challenge","level":"1.4.3","depth":2,"path":"segments/challenges/free-money-overview.md","ref":"segments/challenges/free-money-overview.md","articles":[]},{"title":"Free Money Sample Solution","level":"1.4.4","depth":2,"path":"segments/challenges/free-money-solution.md","ref":"segments/challenges/free-money-solution.md","articles":[]},{"title":"Next Steps","level":"1.4.5","depth":2,"anchor":"#decide-what-to-do-next","path":"plug-intro.md","ref":"plug-intro.md#decide-what-to-do-next","articles":[]}]},"previous":{"title":"The 5 Rs","level":"1.2.2","depth":2,"path":"segments/learning/5-rs.md","ref":"segments/learning/5-rs.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"3.x.x","theme":"default","variables":{"transforms":"/segments/plug/transforms.md","initial-state":"/segments/plug/initial-state.md","cookie-cutter":"/segments/plug/cookie-cutter.md","models":"/segments/plug/models.md","plug":"/segments/plug/","freeMoneyChallenge":"http://github.com/dev-academy-programme/plug-free-money-challenge/","blockchain":"/segments/crypto/blockchain.md","crypto-kiwis":"/crypto-kiwis.md/","decentralisation":"/segments/crypto/decentralisation.md","python":"/segments/python/","prerequisites":"/segments/plug/prerequisites.md","setup":"/segments/plug/setup.md","api-client":"/segments/plug/api-client.md"},"plugins":["collapsible-menu"],"pluginsConfig":{"fontSettings":{"theme":"night"},"collapsible-menu":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css"}},"file":{"path":"setup.md","mtime":"2018-10-04T07:56:18.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-10-05T20:55:39.376Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-collapsible-menu/plugin.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>