annotate README4PACKAGERS @ 1297:ef7e8e23b353 frontends_multi_profiles

quick_frontend: add some properties for QuickContactList
author souliane <souliane@mailoo.org>
date Thu, 05 Feb 2015 12:10:42 +0100
parents 0db0013c59dd
children 32d1089df687
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
1 First of all, thank you for packaging SàT :)
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
2
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
3
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
4 ############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
5 Dependencies
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
6 ############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
7
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
8 SàT requires Python 2.7.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
9 You will find below the list of Python modules the backend and the frontends depend on, as well as additional information.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
10
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
11 ------------------------------
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
12 Dependencies for SàT's backend
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
13 ------------------------------
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
14
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
15 dbus
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
16 lxml
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
17 Mutagen
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
18 PIL
1038
d732bb68b326 fixes setup with PyCrypto minimal version
souliane <souliane@mailoo.org>
parents: 1028
diff changeset
19 PyCrypto >= 2.6.1
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
20 PyFeed
1054
a32ef03d4af0 installation: added python OTR dependency
Goffi <goffi@goffi.org>
parents: 1038
diff changeset
21 Python OTR
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
22 Twisted Core
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
23 Twisted Mail
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
24 Twisted Web
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
25 Twisted Words
1038
d732bb68b326 fixes setup with PyCrypto minimal version
souliane <souliane@mailoo.org>
parents: 1028
diff changeset
26 Wokkel >= 0.7.1
932
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
27 XDG
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
28 xe
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
29 zope.interface
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
30
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
31 Recommended: markdown, html2text
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
32
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
33 --------------------------------
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
34 Dependencies for the Jp frontend
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
35 --------------------------------
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
36
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
37 PyGI (PyGObject 3)
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
38
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
39 Recommended: progressbar
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
40
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
41 ----------------------------------------
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
42 Dependencies for the Primitivus frontend
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
43 ----------------------------------------
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
44
1166
6b15a6d184d5 misc (README4PACKAGERS): Urwid minimal version is now 1.2.0
Goffi <goffi@goffi.org>
parents: 1152
diff changeset
45 Urwid >= 1.2.0
1200
0059c2bb9bd7 misc: update versions in README4PACKAGERS + typos
Matteo Cypriani <mcy@lm7.fr>
parents: 1194
diff changeset
46 Urwid-satext >= 0.4.1
0059c2bb9bd7 misc: update versions in README4PACKAGERS + typos
Matteo Cypriani <mcy@lm7.fr>
parents: 1194
diff changeset
47 GObject 2 (not imported directly in Primitivus, but needed for Urwid's main loop)
0059c2bb9bd7 misc: update versions in README4PACKAGERS + typos
Matteo Cypriani <mcy@lm7.fr>
parents: 1194
diff changeset
48 DBus
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
49
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
50 Suggested: Python X Library (for user notifications in a graphical session)
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
51
932
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
52 --------------------------------------
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
53 Dependencies for the Libervia frontend
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
54 --------------------------------------
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
55
940
92e41e7c7e00 misc: precisions about pyjamas in README4PACKAGERS
Goffi <goffi@goffi.org>
parents: 932
diff changeset
56 pyjamas (for building only)
932
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
57 txJSON-RPC
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
58
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
59 Recommended: pyOpenSSL
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
60
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
61
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
62 ##################
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
63 Satellite projects
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
64 ##################
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
65
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
66 Several project have been made around SàT, they are all available at http://repos.goffi.org:
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
67
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
68 - Libervia: the both Ajax and static web frontend.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
69
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
70 - SàT PubSub: a PubSub service which manage experimental features like fine permission tuning.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
71
932
1e0550271546 misc: updated setup.py and README4PACKAGERS
souliane <souliane@mailoo.org>
parents: 899
diff changeset
72 - SàT media: Media needed by the frontends.
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
73
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
74 - Urwid SàText: Widgets for urwid library, designed for SàT but can be useful for other projects. Mandatory for Primitivus.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
75
1200
0059c2bb9bd7 misc: update versions in README4PACKAGERS + typos
Matteo Cypriani <mcy@lm7.fr>
parents: 1194
diff changeset
76 The following ones are not needed in a distribution, because they are in too early a stage of development, or not useful for general purpose:
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
77
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
78 - Bellaciao: a Qt frontend, at an early stage of development.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
79
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
80 - Salut: an XMPP directory, at a very early stage of development.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
81
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
82 - SàT Website: the code of the website.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
83
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
84
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
85 ########
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
86 Licences
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
87 ########
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
88
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
89 We are careful about the licences we use. Our projects are licenced as follow:
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
90
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
91 - Libervia, SàT PubSub, Bellaciao, Salut, SàT Website: AGPL v3+
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
92
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
93 - Urwid SàText: LGPL v3+
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
94
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
95 When an external code is included (portion or library), we indicate the source and the licence, and we are careful to take Libre licences only. If we made a mistake somewhere, please let us know.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
96
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
97 The case of SàT Media is particular are there is a compilation of media from severals sources. SàT Logo was made by Adrien Vigneron and is under CC By-SA. Other works are all under Free licences, licences are specified in the base directory of each package.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
98
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
99
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
100 #####################
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
101 Packages and versions
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
102 #####################
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
103
1291
0db0013c59dd remove remaining references to Wix
souliane <souliane@mailoo.org>
parents: 1200
diff changeset
104 We have packaged Primitivus and Jp with the core backend, as we think theses frontends should be shipped with each SàT distribution.
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
105
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
106 Libervia is distributed as a separate package because of its specificities (it's a huge project by itself, it uses Pyjamas Python => JS Compiler, etc.). But it's part of the same project.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
107
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
108 All the official frontends have the same version number, which is the version of the backend they use.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
109
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
110
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
111 #######
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
112 Updates
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
113 #######
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
114
1152
c8c7755de5d8 misc: README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 1054
diff changeset
115 There is a SQLite database per user (default in ~/local/share/sat/.sat.db); it is updated automatically if there is a schema change.
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
116
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
117
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
118 ##############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
119 Contrat social
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
120 ##############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
121
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
122 The social contract is an important part of the project, please don't forget to distribute it along with SàT.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
123
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
124
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
125 #############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
126 Miscellaneous
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
127 #############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
128
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
129 There is a completion file for Zsh which detects the parameters of Jp. It's available in the misc/ directory (.jp) and must be available in a path included in user's fpath.
1152
c8c7755de5d8 misc: README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 1054
diff changeset
130
c8c7755de5d8 misc: README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 1054
diff changeset
131 The translations are global to all the frontends (no translations available in Libervia yet). There are not up-to-date since 0.4 version.
c8c7755de5d8 misc: README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 1054
diff changeset
132
c8c7755de5d8 misc: README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 1054
diff changeset
133 The .service file in misc repository is used for auto-launch feature of D-Bus (launching a frontend will automatically launch the backend if it's not already present), setup.py adapt the path once installed. If you put it yourself, be sure that the "Exec=" line link to the sat.sh script.
c8c7755de5d8 misc: README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 1054
diff changeset
134 This file should be in .services dir, usually /usr/share/dbus-1/services/
899
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
135
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
136
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
137 Thank you again for you help; don't forget to give us your name and contact email so we can credit you, and don't hesitate to contact us if you have any question (on the sat XMPP room at sat@chat.jabberfr.org, or check README for individual contacts).