Mercurial > libervia-backend
annotate INSTALL @ 853:c2f6ada7858f
core (sqlite): automatic database update:
- new Updater class check database consistency (by calculating a hash on the .schema), and updates base if necessary
- database now has a version (1 for current, 0 will be for 0.3's database), for each change this version will be increased
- creation statements and update statements are in the form of dict of dict with tuples. There is a help text at the top of the module to explain how it works
- if we are on a development version, the updater try to update the database automaticaly (without deleting table or columns). The Updater.generateUpdateData method can be used to ease the creation of update data (i.e. the dictionary at the top, see the one for the key 1 for an example).
- if there is an inconsistency, an exception is raised, and a message indicate the SQL statements that should fix the situation.
- well... this is rather complicated, a KISS method would maybe have been better. The future will say if we need to simplify it :-/
- new DatabaseError exception
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 23 Feb 2014 23:30:32 +0100 |
parents | 952322b1d490 |
children | 5d08ab99e8dd |
rev | line source |
---|---|
238
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
212
diff
changeset
|
1 *** |
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
212
diff
changeset
|
2 Below are the old manual instructions for installation, you can install SàT automatically using easy_install or pip. The full instructions are available on the wiki: http://wiki.goffi.org/wiki/Salut_%C3%A0_Toi |
587
952322b1d490
Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
548
diff
changeset
|
3 *** |
238
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
212
diff
changeset
|
4 |
83d2bc0abf2a
version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents:
212
diff
changeset
|
5 |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 The following instructions are for GNU/Linux operating system. Instruction for other OS will come in the future. |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 /!\ WARNING /!\ |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 SàT is at a very early developpement stage, and is not intended for end user yet. You need to understand a minimum what you do to install it. Anyway, you can contact me if you need help (but I'm really busy, so don't expect a quick and accurate answer). |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 ** DEPENDENCIES: |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 To use SàT, you will need to install: |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 - twisted (http://twistedmatrix.com/trac/) which is found in most distributions, at least core, web and words must be installed |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 - progressbar (http://pypi.python.org/pypi/progressbar/2.2) which can be installed with easy_install |
188
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
16 - wokkel (http://wokkel.ik.nu/). /!\ the MUC branch (http://hg.ik.nu/ralphm/wokkel-muc-client-support-24-2) must be merged, please read instructions below |
212 | 17 - wxWidgets (http://www.wxwidgets.org) which is found in most distributions. The more recent the version is, the better. |
18 - urwid (http://excess.org/urwid/) which can be installed with easy_install | |
458
094050fe461e
core: fixed Params class name in load_default_params
Goffi <goffi@goffi.org>
parents:
238
diff
changeset
|
19 - Mutagen (http://code.google.com/p/mutagen/) which can be installed with easy_install |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
21 ** PATHS: |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 |
210
9face609f83c
misc minor typos fixes, dev version
Goffi <goffi@goffi.org>
parents:
188
diff
changeset
|
23 You must have the main dir (with sat inside) and frontend in your PYTHONPATH. For example, if you have uncompressed the soft in /tmp/useless_soft: |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
24 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 > export PYTHONPATH=$PYTHONPATH:/tmp/useless_soft:/tmp/useless_soft/frontends |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
26 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
27 if you want to access jp, it can be a good idea to export its dir to your PATH variable: |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
28 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 > export PATH=$PATH:/tmp/useless_soft/frontends/jp |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
31 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
32 ** INSTRUCTIONS: |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
33 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
34 Here are the instructions for the distribution I use (Kubuntu Karmic Koala), but instructions for other Gnu/Linux distributions must be really close. |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
35 To install SàT on a *buntu distribution, you first need to install dependencies: |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
36 |
212 | 37 > sudo aptitude install python-twisted python-twisted-core python-twisted-web python-twisted-words python-wxgtk2.8 |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
38 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
39 You maybe need an updated repository for wxPython, take a look at http://wiki.wxpython.org/InstallingOnUbuntuOrDebian for more informations. |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
40 |
548
8022cca26595
installation: removed BeautifulSoup from dependencies as it was only used by CS plugin which is now deprecated
Goffi <goffi@goffi.org>
parents:
458
diff
changeset
|
41 ProgressBar and Urwid can be installed with easy_install, or throught apt: |
8022cca26595
installation: removed BeautifulSoup from dependencies as it was only used by CS plugin which is now deprecated
Goffi <goffi@goffi.org>
parents:
458
diff
changeset
|
42 > sudo aptitude install python-progressbar python-urwid |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
43 |
188
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
44 Wokkel is a bit more complicated to install as we need to merge two branches: |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
45 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
46 First be sure that mercurial is installed |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
47 > sudo aptitude install mercurial |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
48 |
188
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
49 then we go to a directory where we can clone the repositories and merge. If you don't want to code on wokkel, you can do it in /tmp: |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
50 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
51 > cd /tmp |
188
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
52 > hg clone http://hg.ik.nu/wokkel wokkel |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
53 |
188
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
54 now we pull the other branch: |
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
55 > cd wokkel |
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
56 > hg pull -f http://hg.ik.nu/ralphm/wokkel-muc-client-support-24-2 |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
57 |
188
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
58 time to merge and commit: |
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
59 > hg merge wokkel-muc-client-support-24 |
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
60 > hg commit -m "Merged wokkel's MUC branch" |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
61 |
188
22cbd3837233
updated INSTALL instruction (wokkel MUC branch merge)
Goffi <goffi@goffi.org>
parents:
24
diff
changeset
|
62 finally,we can install: |
24
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
63 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
64 > sudo python setup.py install |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
65 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
66 Everything is fine ? Ok let's add the paths. |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
67 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
68 If you use bash, you need probably to do something like |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
69 > echo "export PYTHONPATH=$PYTHONPATH:~/sat:~/sat/frontends" >> ~/.bashrc |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
70 > echo "export PATH=$PATH:~/sat/frontends/jp" >> ~/.bashrc |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
71 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
72 of course, replace ~/sat with the path where you installed SàT, and if you use zsh, replace .bashrc by .zshrc. |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
73 Restart a console or export manually the PATH. |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
74 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
75 Now everything should be OK, you can launch SàT. You have to launch the daemon first: |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
76 > cd ~/sat |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
77 > ./sat |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
78 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
79 You should be able to close you console or even X Window if you want. |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
80 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
81 Then launch one (ore more) frontend. For exemple, to use Wix: |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
82 > cd ~/sat/frontends/wix |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
83 > ./wix |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
84 |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
85 enjoy =) |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
86 And don't hesitate to give feedback. |
61124cb82fb7
Updated README and licenses (for images), added installation instructions.
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
87 |