Further work on wikitext template.
[philipp/winterrodeln/wradmin.git] / readme.md
1 # wradmin
2
3 Administration web interface for https://www.winterrodeln.org/
4
5 This web application uses flask (http://flask.pocoo.org/) and Python 3.
6
7 ## Run the application
8
9 ```{sh}
10 $ FLASK_APP=wradmin FLASK_DEBUG=1 FLASK_ENV=development WRADMIN_SETTINGS=development.cfg python3 -m flask run
11 $ FLASK_APP=wradmin WRADMIN_SETTINGS=production.cfg python3 -m flask run
12 ```
13
14 ## Test the application
15
16 ```{sh}
17 PYTHONPATH=. FLASK_APP=wradmin WRADMIN_SETTINGS=test.cfg python3 -m unittest
18 ```
19
20
21 ## Run the shell
22
23 Normal Python shell:
24
25 ```{sh}
26 $ FLASK_APP=wradmin FLASK_DEBUG=1 WRADMIN_SETTINGS=development.cfg python3 -m flask shell
27 ```
28
29 Ipython shell:
30
31 ```
32 $ FLASK_APP=wradmin FLASK_DEBUG=1 WRADMIN_SETTINGS=development.cfg ipython
33 >>> from wradmin.app import db
34 >>> from wradmin.model import MwUser
35 >>> user = db.session.query(MwUser).get(1)
36 ```
37
38 ## Deploy
39
40 Development environment:
41
42 ```{sh}
43 $ python setup.py bdist_wheel
44 $ scp bdist/wradmin-2.1.0.dev0-py3-none-any.whl colleen:
45 ```
46
47 Server environment:
48
49 ```{sh}
50 $ bin/wradmin stop
51 $ pip uninstall wradmin
52 $ pip install wradmin-2.1.0.dev0-py3-none-any.whl # or similar
53 $ bin/wradmin start
54 ```