Wiki

Version 254 (Etienne Pallier, 03/22/2016 07:22 pm)

1 1 Etienne Pallier
h1. Technical Documentation for the PYROS project (FGFT-CC)
2 1 Etienne Pallier
3 1 Etienne Pallier
4 1 Etienne Pallier
HOWTO Format Redmine Wiki : http://www.redmine.org/projects/redmine/wiki/FrRedmineWikiFormatting
5 1 Etienne Pallier
6 1 Etienne Pallier
{{>toc}}
7 1 Etienne Pallier
8 1 Etienne Pallier
9 121 Etienne Pallier
---
10 1 Etienne Pallier
11 121 Etienne Pallier
h2. %{margin-left:0px; font-weight:bold; font-size:25px;  display:block; color:red;}I - TODO%
12 121 Etienne Pallier
13 251 Etienne Pallier
 * Intégration dans Eclipse
14 125 Etienne Pallier
15 251 Etienne Pallier
 * Séparation des BD Django et Pyros
16 126 Etienne Pallier
17 174 Etienne Pallier
 * Intégration des modules Django déjà développés
18 125 Etienne Pallier
19 121 Etienne Pallier
20 3 Etienne Pallier
---
21 1 Etienne Pallier
22 140 Etienne Pallier
h2. %{margin-left:0px; font-weight:bold; font-size:25px;  display:block; color:red;}I - DATABASE SCHEMA (v0.2.1)%
23 116 Etienne Pallier
24 116 Etienne Pallier
25 117 Etienne Pallier
{{thumbnail(PYROS_PDM_v021.png, size=300, title=Pyros data model)}}
26 121 Etienne Pallier
27 121 Etienne Pallier
28 121 Etienne Pallier
---
29 116 Etienne Pallier
30 141 Etienne Pallier
h2. %{margin-left:0px; font-weight:bold; font-size:25px;  display:block; color:red;}II - Get the project (from gitlab)%
31 141 Etienne Pallier
32 253 Etienne Pallier
h3. Project structure
33 1 Etienne Pallier
34 253 Etienne Pallier
Once you have fetched the project, you should obtain this structure:
35 1 Etienne Pallier
36 226 Etienne Pallier
<pre>
37 1 Etienne Pallier
38 1 Etienne Pallier
PYROS/
39 254 Etienne Pallier
├── install/
40 254 Etienne Pallier
│   └── REQUIREMENTS.txt
41 254 Etienne Pallier
│   └── INSTALLATION.txt
42 226 Etienne Pallier
├── public/
43 226 Etienne Pallier
│   └── static/
44 226 Etienne Pallier
├── src/
45 226 Etienne Pallier
│   ├── manage.py
46 226 Etienne Pallier
│   ├── pyros/
47 226 Etienne Pallier
│   │   ├── __init__.py
48 226 Etienne Pallier
│   │   ├── __pycache__
49 226 Etienne Pallier
│   │   ├── settings.py
50 1 Etienne Pallier
│   │   ├── urls.py
51 1 Etienne Pallier
│   │   └── wsgi.py
52 1 Etienne Pallier
│   └── pyrosapp/
53 1 Etienne Pallier
│       ├── __init__.py
54 1 Etienne Pallier
│       ├── admin.py
55 1 Etienne Pallier
│       ├── apps.py
56 1 Etienne Pallier
│       ├── migrations
57 1 Etienne Pallier
│       ├── models.py
58 1 Etienne Pallier
│       ├── tests.py
59 1 Etienne Pallier
│       └── views.py
60 1 Etienne Pallier
61 1 Etienne Pallier
62 253 Etienne Pallier
</pre>
63 253 Etienne Pallier
64 253 Etienne Pallier
h3. Get the project from the terminal
65 253 Etienne Pallier
66 253 Etienne Pallier
<pre>
67 253 Etienne Pallier
git clone https://gitlab.irap.omp.eu/epallier/pyros.git PYROS
68 253 Etienne Pallier
69 253 Etienne Pallier
(or also : git clone git@gitlab.irap.omp.eu:epallier/pyros.git)
70 253 Etienne Pallier
</pre>
71 253 Etienne Pallier
72 253 Etienne Pallier
This creates a PYROS/ folder containing the project (with a .git/ subfolder for synchronization with the git repository)
73 253 Etienne Pallier
74 253 Etienne Pallier
_If you just wanted a static copy of the project (without synchronization) just remove the .git/ folder:_
75 253 Etienne Pallier
<pre>
76 253 Etienne Pallier
$ rm -r .git/
77 253 Etienne Pallier
</pre>
78 253 Etienne Pallier
79 253 Etienne Pallier
80 226 Etienne Pallier
81 1 Etienne Pallier
h3. Get the project from Eclipse
82 252 Etienne Pallier
ECLIPSE
83 1 Etienne Pallier
84 252 Etienne Pallier
File/Import project from git
85 252 Etienne Pallier
86 252 Etienne Pallier
Select repository source:
87 252 Etienne Pallier
Clone URI
88 252 Etienne Pallier
89 252 Etienne Pallier
URI: https://gitlab.irap.omp.eu/epallier/pyros.git
90 252 Etienne Pallier
91 252 Etienne Pallier
Directory: 
92 252 Etienne Pallier
par défaut, il propose : /Users/epallier/git/pyros
93 252 Etienne Pallier
mais je préfère le mettre ailleurs
94 252 Etienne Pallier
95 252 Etienne Pallier
initial branch: master
96 252 Etienne Pallier
remote name: origin
97 252 Etienne Pallier
98 252 Etienne Pallier
Import as general project
99 252 Etienne Pallier
100 252 Etienne Pallier
Project name: PYROS
101 252 Etienne Pallier
102 252 Etienne Pallier
The project is created. Now, you have to set it as a «PyDev » and a « Django » project.
103 252 Etienne Pallier
104 252 Etienne Pallier
clic droit sur le projet / PyDev / set as a PyDev project
105 252 Etienne Pallier
106 252 Etienne Pallier
clic droit sur le projet / PyDev / set as a Django project
107 252 Etienne Pallier
108 252 Etienne Pallier
clic droit sur le projet : on doit maintenant avoir un sous-menu Django
109 252 Etienne Pallier
110 252 Etienne Pallier
clic droit sur le dossier src / PyDev / set as source folder (add to PYTHONPATH)
111 252 Etienne Pallier
112 252 Etienne Pallier
clic droit sur projet / Properties / Pydev-Django :
113 252 Etienne Pallier
- Django manage.py : src/manage.py
114 252 Etienne Pallier
- Django settings module : pyros.settings
115 252 Etienne Pallier
116 252 Etienne Pallier
RUN SERVER :
117 252 Etienne Pallier
clic droit sur projet, Django/Custom command/runserver
118 252 Etienne Pallier
119 252 Etienne Pallier
check http://localhost:8000/
120 252 Etienne Pallier
121 252 Etienne Pallier
122 252 Etienne Pallier
123 252 Etienne Pallier
mkdir private
124 252 Etienne Pallier
125 252 Etienne Pallier
sudo port install py35-virtualenv
126 252 Etienne Pallier
127 252 Etienne Pallier
virtualenv-3.5 venv_py35_pyros -p /opt/local/bin/python3.5
128 252 Etienne Pallier
129 252 Etienne Pallier
pip install -r ../PYROS/private/REQUIREMENTS.txt
130 252 Etienne Pallier
131 252 Etienne Pallier
132 252 Etienne Pallier
133 252 Etienne Pallier
134 252 Etienne Pallier
clic droit sur projet / Properties / PyDev - Interpreter/Grammar :
135 252 Etienne Pallier
Grammar version : 3
136 252 Etienne Pallier
Interpreter : click on « click here to configure an interpreter not listed »
137 252 Etienne Pallier
click on « New » :
138 252 Etienne Pallier
- Interpreter name : venv_py35_pyros
139 252 Etienne Pallier
- Interpreter executable : click on « Browse »
140 252 Etienne Pallier
	Select your private/venv_py35_pyros/bin/python3.5 executable
141 252 Etienne Pallier
	click OK
142 252 Etienne Pallier
	click OK again
143 252 Etienne Pallier
144 252 Etienne Pallier
Interpreter: select now venv_py35_pyros from the list
145 252 Etienne Pallier
146 252 Etienne Pallier
147 252 Etienne Pallier
Code style checking:
148 252 Etienne Pallier
149 252 Etienne Pallier
Window/Preferences : Pydev / Editor
150 252 Etienne Pallier
- Auto Imports : uncheck « Do auto import »
151 252 Etienne Pallier
- Code style:
152 252 Etienne Pallier
	- Locals … : camelCase
153 252 Etienne Pallier
	- Methods : camelCase() with first lower
154 252 Etienne Pallier
- Code style / Code Formatter: activer « use autopep8.py for code formatting »
155 252 Etienne Pallier
- Tabs : Tab length : 4
156 252 Etienne Pallier
157 252 Etienne Pallier
158 252 Etienne Pallier
159 252 Etienne Pallier
160 169 Etienne Pallier
161 141 Etienne Pallier
h2. %{margin-left:0px; font-weight:bold; font-size:25px;  display:block; color:red;}III - INSTALLATION%
162 2 Etienne Pallier
163 120 Etienne Pallier
164 120 Etienne Pallier
---
165 120 Etienne Pallier
166 184 Etienne Pallier
h3. Install MySql (only if necessary)
167 2 Etienne Pallier
168 49 Etienne Pallier
 * Linux Ubuntu
169 49 Etienne Pallier
<pre>
170 107 Paul Carensac
171 107 Paul Carensac
$ sudo apt-get install mysql-server
172 107 Paul Carensac
$ sudo apt-get install mysql-client
173 107 Paul Carensac
174 49 Etienne Pallier
</pre>
175 49 Etienne Pallier
176 49 Etienne Pallier
 * Linux CentOS
177 49 Etienne Pallier
<pre>
178 49 Etienne Pallier
TODO:
179 49 Etienne Pallier
$ sudo yum install mysql
180 49 Etienne Pallier
...
181 49 Etienne Pallier
</pre>
182 49 Etienne Pallier
183 49 Etienne Pallier
 * Mac OS X
184 1 Etienne Pallier
Install XAMPP
185 1 Etienne Pallier
(but you could also use the pre-installed Mac OS MySql)
186 177 Etienne Pallier
<pre>
187 177 Etienne Pallier
TODO:
188 49 Etienne Pallier
</pre>
189 1 Etienne Pallier
190 49 Etienne Pallier
 * Windows
191 243 Paul Carensac
192 1 Etienne Pallier
<pre>
193 243 Paul Carensac
Download and install the newest version on https://dev.mysql.com/downloads/installer/
194 243 Paul Carensac
195 243 Paul Carensac
Once installed, launch MySQL Installer. Clic on 'Add...' on the right.
196 243 Paul Carensac
In MySQLServers section, choose the newest, then clic on next.
197 243 Paul Carensac
Install and configure the server (just follow the installation guide).
198 243 Paul Carensac
199 243 Paul Carensac
Then launch mysql (via the Windows menu).
200 49 Etienne Pallier
</pre>
201 49 Etienne Pallier
202 49 Etienne Pallier
203 49 Etienne Pallier
---
204 1 Etienne Pallier
205 185 Etienne Pallier
h3. Install Python3.5 (only if necessary)
206 1 Etienne Pallier
207 11 Etienne Pallier
208 11 Etienne Pallier
 * Mac OS X :
209 1 Etienne Pallier
<pre>
210 183 Etienne Pallier
211 24 Etienne Pallier
1) Installer MacPort
212 24 Etienne Pallier
(TODO: doc)
213 24 Etienne Pallier
214 24 Etienne Pallier
2) Installer le "port" python35
215 1 Etienne Pallier
$ sudo port install python35
216 183 Etienne Pallier
217 1 Etienne Pallier
</pre>
218 1 Etienne Pallier
219 1 Etienne Pallier
 * Linux (Ubuntu) :
220 1 Etienne Pallier
<pre>
221 244 Paul Carensac
$ sudo add-apt-repository ppa:fkrull/deadsnakes
222 244 Paul Carensac
$ sudo apt-get update
223 244 Paul Carensac
$ sudo apt-get install python3.5
224 1 Etienne Pallier
225 244 Paul Carensac
$ sudo pip install virtualenv
226 1 Etienne Pallier
</pre>
227 1 Etienne Pallier
228 244 Paul Carensac
229 244 Paul Carensac
 * Windows 7 :
230 244 Paul Carensac
<pre>
231 244 Paul Carensac
Go to https://www.python.org/downloads/windows/ , choose the wanted version
232 244 Paul Carensac
On the wanted version’s page, download Windows x86 executable installer
233 244 Paul Carensac
234 244 Paul Carensac
Run the executable
235 244 Paul Carensac
    * On the first page, check "Add python3.5 to PATH"
236 244 Paul Carensac
    * Choose "Install now" option
237 245 Paul Carensac
238 245 Paul Carensac
Open cmd (windows + R, cmd) :
239 245 Paul Carensac
 $ python -m pip install --upgrade pip
240 245 Paul Carensac
 $ pip install virtualenv
241 244 Paul Carensac
</pre>
242 1 Etienne Pallier
243 183 Etienne Pallier
 * Windows 10 :
244 183 Etienne Pallier
<pre>
245 187 Etienne Pallier
TODO:
246 183 Etienne Pallier
</pre>
247 3 Etienne Pallier
248 4 Etienne Pallier
---
249 5 Etienne Pallier
250 192 Etienne Pallier
h3. Create a Python3 virtual environment dedicated to the project (inside the project folder)
251 127 Etienne Pallier
252 131 Etienne Pallier
<pre>
253 1 Etienne Pallier
254 193 Etienne Pallier
$ mkdir private/
255 193 Etienne Pallier
256 133 Etienne Pallier
$ cd private/
257 3 Etienne Pallier
258 246 Paul Carensac
$ which python3.5 ("where python" for windows)
259 3 Etienne Pallier
/opt/local/bin/python3.5
260 15 Etienne Pallier
261 127 Etienne Pallier
$ virtualenv-3.5 venv_py35_pyros -p /opt/local/bin/python3.5
262 3 Etienne Pallier
=> creates a venv_py35_pyros/ folder inside PYROS/private/
263 1 Etienne Pallier
264 131 Etienne Pallier
</pre>
265 1 Etienne Pallier
266 7 Etienne Pallier
---
267 3 Etienne Pallier
268 65 Etienne Pallier
h3. Activate the python virtual environment (from inside the project)
269 7 Etienne Pallier
270 55 Etienne Pallier
<pre>
271 1 Etienne Pallier
272 65 Etienne Pallier
$ pwd
273 134 Etienne Pallier
.../PYROS/private
274 1 Etienne Pallier
275 247 Paul Carensac
$ source ./venv_py35_pyros/bin/activate (venv_py35_pyros/Scripts/activate on Windows)
276 247 Paul Carensac
277 65 Etienne Pallier
278 3 Etienne Pallier
$ python -V
279 1 Etienne Pallier
Python 3.5.1
280 3 Etienne Pallier
281 3 Etienne Pallier
$ which pip
282 77 Etienne Pallier
.../PYROS/venv_py35_pyros/bin/pip
283 16 Etienne Pallier
284 194 Etienne Pallier
Upgrade pip to last version available:
285 3 Etienne Pallier
$ pip install --upgrade pip
286 3 Etienne Pallier
Collecting pip
287 3 Etienne Pallier
  Downloading pip-8.1.1-py2.py3-none-any.whl (1.2MB)
288 3 Etienne Pallier
Installing collected packages: pip
289 3 Etienne Pallier
  Found existing installation: pip 7.1.2
290 3 Etienne Pallier
    Uninstalling pip-7.1.2:
291 3 Etienne Pallier
      Successfully uninstalled pip-7.1.2
292 1 Etienne Pallier
Successfully installed pip-8.1.1
293 194 Etienne Pallier
294 194 Etienne Pallier
Upgrade wheel to last version available:
295 194 Etienne Pallier
$ pip install --upgrade wheel
296 194 Etienne Pallier
Collecting wheel
297 194 Etienne Pallier
  Downloading wheel-0.29.0-py2.py3-none-any.whl (66kB)
298 194 Etienne Pallier
Installing collected packages: wheel
299 194 Etienne Pallier
  Found existing installation: wheel 0.24.0
300 194 Etienne Pallier
    Uninstalling wheel-0.24.0:
301 194 Etienne Pallier
      Successfully uninstalled wheel-0.24.0
302 194 Etienne Pallier
Successfully installed wheel-0.29.0
303 194 Etienne Pallier
304 55 Etienne Pallier
305 55 Etienne Pallier
</pre>
306 18 Etienne Pallier
307 212 Etienne Pallier
h3. Install the needed Python packages (from within the virtual environment)
308 18 Etienne Pallier
309 66 Etienne Pallier
First, be sure that the virtual environment is activated:
310 66 Etienne Pallier
<pre>
311 66 Etienne Pallier
$ python -V
312 66 Etienne Pallier
Python 3.5.1
313 66 Etienne Pallier
</pre>
314 66 Etienne Pallier
315 62 Etienne Pallier
 * *Automatic Installation of all packages*
316 62 Etienne Pallier
<pre>
317 90 Etienne Pallier
$ pip install -r REQUIREMENTS.txt
318 62 Etienne Pallier
</pre>
319 62 Etienne Pallier
320 93 Etienne Pallier
 * *Or, manual installation of each package*
321 62 Etienne Pallier
322 62 Etienne Pallier
  * *Install Django* :
323 32 Etienne Pallier
<pre>
324 3 Etienne Pallier
$ pip install django
325 3 Etienne Pallier
Collecting django
326 3 Etienne Pallier
  Downloading Django-1.9.4-py2.py3-none-any.whl (6.6MB)
327 3 Etienne Pallier
Installing collected packages: django
328 3 Etienne Pallier
Successfully installed django-1.9.4
329 3 Etienne Pallier
330 3 Etienne Pallier
$ pip install django-admin-tools
331 3 Etienne Pallier
Collecting django-admin-tools
332 3 Etienne Pallier
  Downloading django_admin_tools-0.7.2-py2.py3-none-any.whl (289kB)
333 3 Etienne Pallier
Installing collected packages: django-admin-tools
334 3 Etienne Pallier
Successfully installed django-admin-tools-0.7.2
335 3 Etienne Pallier
336 21 Etienne Pallier
$ pip install django-debug-toolbar
337 21 Etienne Pallier
Collecting django-debug-toolbar
338 21 Etienne Pallier
  Downloading django_debug_toolbar-1.4-py2.py3-none-any.whl (212kB)
339 21 Etienne Pallier
Requirement already satisfied (use --upgrade to upgrade): Django>=1.7 in ./venv_py35_pyros/lib/python3.5/site-packages (from django-debug-toolbar)
340 21 Etienne Pallier
Collecting sqlparse (from django-debug-toolbar)
341 21 Etienne Pallier
  Downloading sqlparse-0.1.19.tar.gz (58kB)
342 21 Etienne Pallier
Building wheels for collected packages: sqlparse
343 21 Etienne Pallier
  Running setup.py bdist_wheel for sqlparse ... done
344 21 Etienne Pallier
  Stored in directory: /Users/epallier/Library/Caches/pip/wheels/7b/d4/72/6011bb100dd5fc213164e4bbee13d4e03261dd54ce6a5de6b8
345 21 Etienne Pallier
Successfully built sqlparse
346 21 Etienne Pallier
Installing collected packages: sqlparse, django-debug-toolbar
347 21 Etienne Pallier
Successfully installed django-debug-toolbar-1.4 sqlparse-0.1.19
348 21 Etienne Pallier
349 21 Etienne Pallier
$ pip install django-extensions
350 21 Etienne Pallier
Collecting django-extensions
351 21 Etienne Pallier
  Downloading django_extensions-1.6.1-py2.py3-none-any.whl (202kB)
352 21 Etienne Pallier
Collecting six>=1.2 (from django-extensions)
353 21 Etienne Pallier
  Downloading six-1.10.0-py2.py3-none-any.whl
354 21 Etienne Pallier
Installing collected packages: six, django-extensions
355 21 Etienne Pallier
Successfully installed django-extensions-1.6.1 six-1.10.0
356 21 Etienne Pallier
357 21 Etienne Pallier
$ pip install django-suit
358 21 Etienne Pallier
Collecting django-suit
359 21 Etienne Pallier
  Downloading django-suit-0.2.18.tar.gz (587kB)
360 21 Etienne Pallier
Building wheels for collected packages: django-suit
361 1 Etienne Pallier
  Running setup.py bdist_wheel for django-suit ... done
362 1 Etienne Pallier
  Stored in directory: /Users/epallier/Library/Caches/pip/wheels/12/8b/9a/e02ab0ad9229881638aa040d47d77c8f562999533811927d41
363 1 Etienne Pallier
Successfully built django-suit
364 1 Etienne Pallier
Installing collected packages: django-suit
365 1 Etienne Pallier
Successfully installed django-suit-0.2.18
366 21 Etienne Pallier
367 32 Etienne Pallier
</pre>
368 32 Etienne Pallier
369 63 Etienne Pallier
  * *Install the web application server gunicorn (will be used in production instead of the dev django web server)* :
370 32 Etienne Pallier
<pre>
371 25 Etienne Pallier
$ pip install gunicorn
372 25 Etienne Pallier
Collecting gunicorn
373 25 Etienne Pallier
  Downloading gunicorn-19.4.5-py2.py3-none-any.whl (112kB)
374 21 Etienne Pallier
Installing collected packages: gunicorn
375 26 Etienne Pallier
Successfully installed gunicorn-19.4.5
376 1 Etienne Pallier
</pre>
377 1 Etienne Pallier
378 63 Etienne Pallier
  * *Install the python mysql client*:
379 32 Etienne Pallier
<pre>
380 32 Etienne Pallier
$ pip install mysqlclient
381 72 Etienne Pallier
...
382 72 Etienne Pallier
</pre>
383 33 Etienne Pallier
384 73 Etienne Pallier
   * => Issue under Mac OS X:
385 72 Etienne Pallier
<pre>
386 3 Etienne Pallier
$ pip install mysqlclient
387 3 Etienne Pallier
Collecting mysqlclient
388 1 Etienne Pallier
  Downloading mysqlclient-1.3.7.tar.gz (79kB)
389 22 Etienne Pallier
Building wheels for collected packages: mysqlclient
390 3 Etienne Pallier
  Running setup.py bdist_wheel for mysqlclient ... error
391 3 Etienne Pallier
392 1 Etienne Pallier
  ----------------------------------------
393 1 Etienne Pallier
  Failed building wheel for mysqlclient
394 1 Etienne Pallier
  Running setup.py clean for mysqlclient
395 1 Etienne Pallier
Failed to build mysqlclient
396 1 Etienne Pallier
Installing collected packages: mysqlclient
397 1 Etienne Pallier
  Running setup.py install for mysqlclient ... done
398 1 Etienne Pallier
Successfully installed mysqlclient-1.3.7
399 1 Etienne Pallier
400 1 Etienne Pallier
BOUH !!!
401 1 Etienne Pallier
402 1 Etienne Pallier
$ pip install --upgrade wheel
403 1 Etienne Pallier
Collecting wheel
404 1 Etienne Pallier
  Downloading wheel-0.29.0-py2.py3-none-any.whl (66kB)
405 1 Etienne Pallier
Installing collected packages: wheel
406 1 Etienne Pallier
  Found existing installation: wheel 0.24.0
407 1 Etienne Pallier
    Uninstalling wheel-0.24.0:
408 1 Etienne Pallier
      Successfully uninstalled wheel-0.24.0
409 1 Etienne Pallier
Successfully installed wheel-0.29.0
410 1 Etienne Pallier
411 1 Etienne Pallier
$ pip uninstall mysqlclient
412 1 Etienne Pallier
413 1 Etienne Pallier
$ pip install mysqlclient
414 1 Etienne Pallier
Collecting mysqlclient
415 1 Etienne Pallier
  Using cached mysqlclient-1.3.7.tar.gz
416 1 Etienne Pallier
Building wheels for collected packages: mysqlclient
417 1 Etienne Pallier
  Running setup.py bdist_wheel for mysqlclient ... done
418 1 Etienne Pallier
  Stored in directory: /Users/epallier/Library/Caches/pip/wheels/9b/06/50/d11418c26cf8f2156b13d4363b5afde8e7e75ebb8540d0228d
419 1 Etienne Pallier
Successfully built mysqlclient
420 1 Etienne Pallier
Installing collected packages: mysqlclient
421 1 Etienne Pallier
Successfully installed mysqlclient-1.3.7
422 1 Etienne Pallier
423 1 Etienne Pallier
YES !!!
424 1 Etienne Pallier
425 1 Etienne Pallier
</pre>
426 1 Etienne Pallier
427 107 Paul Carensac
   * => Issues under Ubuntu:
428 107 Paul Carensac
<pre>
429 107 Paul Carensac
$ pip install mysqlclient
430 107 Paul Carensac
Collecting mysqlclient
431 107 Paul Carensac
  Downloading mysqlclient-1.3.7.tar.gz (79kB)
432 107 Paul Carensac
    100% |████████████████████████████████| 81kB 1.5MB/s
433 107 Paul Carensac
    Complete output from command python setup.py egg_info:
434 107 Paul Carensac
    /bin/sh: 1: mysql_config: not found
435 107 Paul Carensac
    Traceback (most recent call last):
436 107 Paul Carensac
      File "<string>", line 1, in <module>
437 107 Paul Carensac
    [...]
438 107 Paul Carensac
    ----------------------------------------
439 107 Paul Carensac
Command "python setup.py egg_info" failed with error code 1 in /tmp/pip-build-q6j4inuz/mysqlclient/
440 1 Etienne Pallier
441 108 Paul Carensac
BOUH !!!
442 108 Paul Carensac
443 107 Paul Carensac
$ sudo apt-get install libmysqlclient-dev
444 108 Paul Carensac
445 107 Paul Carensac
$ pip install mysqlclient
446 107 Paul Carensac
Collecting mysqlclient
447 107 Paul Carensac
  Using cached mysqlclient-1.3.7.tar.gz
448 107 Paul Carensac
Building wheels for collected packages: mysqlclient
449 107 Paul Carensac
  Running setup.py bdist_wheel for mysqlclient ... error
450 107 Paul Carensac
451 107 Paul Carensac
    _mysql.c:40:20: fatal error: Python.h: No such file or directory
452 107 Paul Carensac
     #include "Python.h"
453 107 Paul Carensac
                        ^
454 107 Paul Carensac
    compilation terminated.
455 107 Paul Carensac
    error: command 'x86_64-linux-gnu-gcc' failed with exit status 1
456 107 Paul Carensac
    
457 107 Paul Carensac
    ----------------------------------------
458 107 Paul Carensac
Command "/home/carens_p/pyros/venv_py35_pyros/bin/python3.5 -u -c "import setuptools, tokenize;__file__='/tmp/pip-build-k3klv92j/mysqlclient/setup.py';exec(compile(getattr(tokenize, 'open', open)(__file__).read().replace('\r\n', '\n'), __file__, 'exec'))" install --record /tmp/pip-gz242xxs-record/install-record.txt --single-version-externally-managed --compile --install-headers /home/carens_p/pyros/venv_py35_pyros/include/site/python3.5/mysqlclient" failed with error code 1 in /tmp/pip-build-k3klv92j/mysqlclient/
459 107 Paul Carensac
460 108 Paul Carensac
BOUH !!!
461 108 Paul Carensac
462 107 Paul Carensac
$ sudo apt-get install python3.5-dev
463 108 Paul Carensac
464 107 Paul Carensac
$ pip install mysqlclient
465 107 Paul Carensac
466 107 Paul Carensac
YES !!!
467 107 Paul Carensac
468 107 Paul Carensac
</pre>
469 12 Etienne Pallier
470 250 Paul Carensac
 * => Issue under Windows
471 250 Paul Carensac
<pre>
472 250 Paul Carensac
Same message as the issue for Mac.
473 250 Paul Carensac
474 250 Paul Carensac
Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#mysqlclient to download the newest mysqlclient wheel
475 250 Paul Carensac
476 250 Paul Carensac
$ pip install path\to\mysqlclient\wheel
477 250 Paul Carensac
478 250 Paul Carensac
No need to redo "pip install mysqlclient"
479 250 Paul Carensac
</pre>
480 250 Paul Carensac
481 12 Etienne Pallier
---
482 28 Etienne Pallier
483 142 Etienne Pallier
h3. Test the project
484 142 Etienne Pallier
485 142 Etienne Pallier
<pre>
486 142 Etienne Pallier
487 150 Etienne Pallier
$ cd src/
488 150 Etienne Pallier
489 1 Etienne Pallier
$ ./manage.py runserver
490 38 Etienne Pallier
(or gunicorn pyros.wsgi)
491 3 Etienne Pallier
==> http://localhost:8000
492 87 Etienne Pallier
...
493 87 Etienne Pallier
...
494 87 Etienne Pallier
Ctrl-c
495 87 Etienne Pallier
496 1 Etienne Pallier
</pre>
497 142 Etienne Pallier
498 142 Etienne Pallier
499 142 Etienne Pallier
500 142 Etienne Pallier
---
501 142 Etienne Pallier
502 156 Paul Carensac
h2. %{margin-left:0px; font-weight:bold; font-size:25px;  display:block; color:red;}IV - CONFIGURATION of the Django Back Office (administration interface)%
503 155 Paul Carensac
504 155 Paul Carensac
---
505 155 Paul Carensac
506 155 Paul Carensac
h3. Back Office setup
507 155 Paul Carensac
508 155 Paul Carensac
 * Prerequisites in src/pyros/settings.py :
509 155 Paul Carensac
510 155 Paul Carensac
    * INSTALLED_APPS must (at least) contain :
511 155 Paul Carensac
512 155 Paul Carensac
        * django.contrib.admin
513 155 Paul Carensac
        * django.contrib.auth
514 155 Paul Carensac
        * django.contrib.contenttypes
515 155 Paul Carensac
        * django.contrib.sessions
516 155 Paul Carensac
517 155 Paul Carensac
    * MIDDLEWARES must (at least) contain :
518 155 Paul Carensac
519 155 Paul Carensac
        * django.contrib.sessions.middleware.SessionMiddleware
520 155 Paul Carensac
        * django.middleware.common.CommonMiddleware
521 155 Paul Carensac
        * django.contrib.auth.middleware.AuthenticationMiddleware
522 155 Paul Carensac
523 155 Paul Carensac
 * At least one 'python manage.py migrate' must have been executed
524 155 Paul Carensac
525 155 Paul Carensac
 * Create a superuser for the administration :
526 155 Paul Carensac
527 155 Paul Carensac
<pre>
528 155 Paul Carensac
$ python manage.py createsuperuser
529 155 Paul Carensac
</pre>
530 155 Paul Carensac
531 156 Paul Carensac
* For each app of the project, fill the admin.py file :
532 155 Paul Carensac
533 155 Paul Carensac
<pre>
534 155 Paul Carensac
from django.contrib import admin
535 155 Paul Carensac
from app.models import Model1, Model2
536 155 Paul Carensac
537 155 Paul Carensac
admin.site.register(Model1)
538 155 Paul Carensac
admin.site.register(Model2)
539 155 Paul Carensac
</pre>
540 155 Paul Carensac
541 155 Paul Carensac
*Reminder* : each application must be registered in the settings.py INSTALLED_APPS variable.
542 157 Paul Carensac
543 168 Paul Carensac
* For each model in models.py, add a '__str__()' method in order to identify the object on the back office. Example :
544 157 Paul Carensac
545 157 Paul Carensac
<pre>
546 157 Paul Carensac
class UserLevel(models.Model):
547 157 Paul Carensac
    name = models.CharField(max_length=45, blank=True, null=True)
548 157 Paul Carensac
    desc = models.TextField(blank=True, null=True)
549 157 Paul Carensac
    priority = models.IntegerField(blank=True, null=True)
550 157 Paul Carensac
    quota = models.FloatField(blank=True, null=True)
551 157 Paul Carensac
552 157 Paul Carensac
    class Meta:
553 157 Paul Carensac
        managed = True
554 157 Paul Carensac
        db_table = 'userlevel'
555 157 Paul Carensac
556 157 Paul Carensac
    def __str__(self):
557 163 Paul Carensac
        return (str(self.name))
558 157 Paul Carensac
</pre>
559 157 Paul Carensac
560 159 Paul Carensac
*Naming convention* : Use self.name when possible, the creation time/date otherwise. Example :
561 159 Paul Carensac
562 159 Paul Carensac
<pre>
563 159 Paul Carensac
class SiteWatch(models.Model):
564 159 Paul Carensac
    updated = models.DateTimeField(blank=True, null=True)
565 159 Paul Carensac
    lights = models.CharField(max_length=45, blank=True, null=True)
566 159 Paul Carensac
    dome = models.CharField(max_length=45, blank=True, null=True)
567 159 Paul Carensac
    doors = models.CharField(max_length=45, blank=True, null=True)
568 159 Paul Carensac
    temperature = models.FloatField(blank=True, null=True)
569 159 Paul Carensac
570 159 Paul Carensac
    class Meta:
571 159 Paul Carensac
        managed = True
572 159 Paul Carensac
        db_table = 'sitewatch'
573 159 Paul Carensac
574 159 Paul Carensac
    def __str__(self):
575 160 Paul Carensac
        return (str(self.updated))
576 159 Paul Carensac
</pre>
577 173 Etienne Pallier
578 211 Paul Carensac
---
579 211 Paul Carensac
580 211 Paul Carensac
h3. Adaptation of the one-to-many and many-to-many display
581 211 Paul Carensac
582 211 Paul Carensac
* The one-to-many relationships are the following (One.many format) :
583 211 Paul Carensac
584 211 Paul Carensac
    * Schedule.sequences
585 211 Paul Carensac
    * Request.sequences
586 211 Paul Carensac
    * Sequence.albums
587 211 Paul Carensac
    * Album.plans
588 211 Paul Carensac
    * Plan.images
589 211 Paul Carensac
    * Telescope.detectors
590 211 Paul Carensac
    * Detector.filters
591 211 Paul Carensac
    * NrtAnalysis.images
592 211 Paul Carensac
    * Filter.plans
593 211 Paul Carensac
    * Detector.albums
594 211 Paul Carensac
    * UserLevel.users
595 211 Paul Carensac
    * Country.users
596 211 Paul Carensac
    * ScientificProgram.requests
597 211 Paul Carensac
    * User.requests
598 211 Paul Carensac
    * StrategyObs.alerts
599 211 Paul Carensac
    * SequenceType.sequences
600 211 Paul Carensac
601 211 Paul Carensac
* For each "many", create a new class in admin.py just after the imports, following these examples :
602 211 Paul Carensac
603 211 Paul Carensac
<pre>
604 211 Paul Carensac
605 211 Paul Carensac
For Schedule.sequences, Request.sequences and Sequentype.sequences, we will need :
606 211 Paul Carensac
607 211 Paul Carensac
class SequenceInline(admin.TabularInline):
608 211 Paul Carensac
    model = Sequence
609 211 Paul Carensac
    fields = ("name",)
610 211 Paul Carensac
    show_change_link = True
611 211 Paul Carensac
612 211 Paul Carensac
613 211 Paul Carensac
For Sequence.albums and Detector.albums, we will need :
614 211 Paul Carensac
615 211 Paul Carensac
class AlbumInline(admin.TabularInline):
616 211 Paul Carensac
    model = Album
617 211 Paul Carensac
    fields = ("name",)
618 211 Paul Carensac
    show_change_link = True
619 211 Paul Carensac
620 211 Paul Carensac
621 211 Paul Carensac
For StrategyObs.alerts, we will need :
622 211 Paul Carensac
623 211 Paul Carensac
class AlertInline(admin.TabularInline):
624 211 Paul Carensac
    model = Alert
625 211 Paul Carensac
    fields = ("request.name",) # there is no 'name' attribute in the Alert model
626 211 Paul Carensac
    show_change_link = True
627 211 Paul Carensac
628 211 Paul Carensac
</pre>
629 211 Paul Carensac
630 222 Paul Carensac
* For each "One", declare a new class in admin.py, just after the "Inlines" class declaration, as done in the following examples :
631 211 Paul Carensac
632 222 Paul Carensac
<pre>
633 222 Paul Carensac
For Request.sequences :
634 222 Paul Carensac
635 222 Paul Carensac
class RequestAdmin(admin.ModelAdmin):
636 222 Paul Carensac
    inlines = [
637 222 Paul Carensac
	SequenceInline,
638 222 Paul Carensac
    ]
639 222 Paul Carensac
640 222 Paul Carensac
For Detector.filters and Detector.albums :
641 222 Paul Carensac
642 222 Paul Carensac
class DetectorAdmin(admin.ModelAdmin):
643 222 Paul Carensac
    inlines = [
644 222 Paul Carensac
	FilterInline,
645 222 Paul Carensac
        AlbumInline,
646 222 Paul Carensac
    ]
647 222 Paul Carensac
648 222 Paul Carensac
</pre>
649 222 Paul Carensac
650 232 Paul Carensac
651 222 Paul Carensac
* The many-to-many relationships are the following :
652 232 Paul Carensac
653 222 Paul Carensac
    * ScientificProgram - User
654 222 Paul Carensac
    * ScheduleHistory - Sequence
655 222 Paul Carensac
656 222 Paul Carensac
* For each many-to-many relationship, declare a new "Inline" class in admin.py just after the imports, like this :
657 222 Paul Carensac
658 222 Paul Carensac
<pre>
659 222 Paul Carensac
For ScientificProgram - User :
660 222 Paul Carensac
661 222 Paul Carensac
class UserAndSPInline(admin.TabularInline):
662 222 Paul Carensac
    model = ScientificProgram.users.through
663 222 Paul Carensac
664 222 Paul Carensac
665 222 Paul Carensac
For ScheduleHistory - Sequence
666 222 Paul Carensac
667 222 Paul Carensac
class SequenceAndSHInline(admin.TabularInline):
668 222 Paul Carensac
    model = ScheduleHistory.sequences.through
669 222 Paul Carensac
670 222 Paul Carensac
</pre>
671 222 Paul Carensac
672 222 Paul Carensac
+Note :+ The order in the line "model = ScientificProgram.users.through" is very important : the first model (ScientificProgram) is the one in which is declared the ManyToManyField relationship.
673 232 Paul Carensac
674 232 Paul Carensac
* For each many-to-many relationship, declare two new classes in admin.py, just after the inlines, like in the following examples :
675 232 Paul Carensac
676 232 Paul Carensac
<pre>
677 232 Paul Carensac
For the ScheduleHistory - Sequence relationship :
678 232 Paul Carensac
679 232 Paul Carensac
class ScheduleHistoryAdmin(admin.ModelAdmin):
680 232 Paul Carensac
    inlines = [
681 232 Paul Carensac
        SequenceAndSHInline,
682 232 Paul Carensac
    ]
683 232 Paul Carensac
    exclude = ('sequences',) # ScheduleHistory declares the ManyToManyField, and we want to replace its display in the back office, so we won't display the default field
684 232 Paul Carensac
685 232 Paul Carensac
class SequenceAdmin(admin.ModelAdmin):
686 232 Paul Carensac
    inlines = [
687 232 Paul Carensac
        AlbumInline,        # This is the Inline for the one-to-many relationship Sequence.albums
688 232 Paul Carensac
        SequenceAndSHInline,                                                                
689 232 Paul Carensac
    ]
690 232 Paul Carensac
691 232 Paul Carensac
For the ScientificProgram - User relationship :
692 232 Paul Carensac
693 232 Paul Carensac
class ScientificProgramAdmin(admin.ModelAdmin):
694 232 Paul Carensac
    inlines = [
695 232 Paul Carensac
        RequestInline,
696 232 Paul Carensac
	UserAndSPInline,                                                                         
697 232 Paul Carensac
    ]
698 232 Paul Carensac
    exclude = ('users',) # Same as ScheduleHistory                                                                         
699 232 Paul Carensac
700 232 Paul Carensac
class UserAdmin(admin.ModelAdmin):
701 232 Paul Carensac
    inlines = [
702 232 Paul Carensac
	RequestInline,   # This is the Inline for the one-to-many relationship User.requests
703 232 Paul Carensac
        UserAndSPInline,                                                                    
704 232 Paul Carensac
    ]
705 232 Paul Carensac
706 232 Paul Carensac
</pre>
707 232 Paul Carensac
708 235 Paul Carensac
* For each ModelAdmin class in the admin.py, change the registering line
709 235 Paul Carensac
710 235 Paul Carensac
<pre>
711 235 Paul Carensac
admin.site.register(Album)
712 235 Paul Carensac
</pre>
713 235 Paul Carensac
714 235 Paul Carensac
to
715 235 Paul Carensac
716 235 Paul Carensac
<pre>
717 235 Paul Carensac
admin.site.register(Album, AlbumAdmin)
718 235 Paul Carensac
</pre>
719 211 Paul Carensac
720 229 Etienne Pallier
h2. %{margin-left:0px; font-weight:bold; font-size:25px;  display:block; color:red;}V - INSTALLATION FROM THE BEGINNING (for dev only, history of the initial project creation)%
721 1 Etienne Pallier
722 236 Etienne Pallier
723 242 Etienne Pallier
[[pyros_install_from_start|Pyros installation from the beginning]]