Mercurial > libervia-backend

annotate README4PACKAGERS @ 919:ed9841e6d84a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: added IQ_SET to core.constants + getLastResource now manage correctly jid.JID
author Goffi <goffi@goffi.org>
date Sat, 22 Mar 2014 13:42:59 +0100
parents 7565d3ac0a96
children 1e0550271546
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
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
19 PyFeed
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
20 Twisted Core
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
21 Twisted Mail
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
22 Twisted Web
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
23 Twisted Words
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
24 Wokkel
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
25 xe
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
26 zope.interface
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
27
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
28 Recommended: markdown, html2text
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
29
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 Dependencies for the Jp frontend
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 PyGI (PyGObject 3)
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 Recommended: progressbar
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
37
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 Dependencies for the Primitivus frontend
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 dbus
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
43 Urwid
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
44 Urwid-satext
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
45 GObject (not imported directly in Primitivus, but needed for Urwid's main loop)
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
46
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
47 Suggested: Python X Library (for user notifications in a graphical session)
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
48
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 Dependencies for the Wix frontend
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
51 ---------------------------------
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
52
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
53 wxPython
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
54
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
55
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
56 ##################
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
57 Satellite projects
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
58 ##################
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
59
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
60 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
61
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
62 - Libervia: the both Ajax and static web frontend.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
63
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
64 - 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
65
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
66 - SàT media: Media needed to by the frontends.
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 - 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
69
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
70 The following ones are not needed in a distribution, because there are in too early a stage of development, or not useful for general purpose:
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
71
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
72 - Bellaciao: a Qt frontend, at an early stage of development.
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 - Salut: an XMPP directory, at a very early stage of development.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
75
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
76 - SàT Website: the code of the website.
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
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 Licences
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
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
83 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
84
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
85 - Libervia, SàT PubSub, Bellaciao, Salut, SàT Website: AGPL v3+
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
86
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
87 - Urwid SàText: LGPL v3+
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 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
90
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
91 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
92
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
93
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 Packages and versions
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
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
98 We have packaged Wix, Primitivus, and Jp with the core backend, as we think theses frontends should be shipped with each SàT distribution. But allowing them to be installed separately would be good: for example, Wix will be useless for a server or non-graphical workstation.
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 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
101
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
102 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
103
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
104
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 Updates
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
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
109 There is a SQLite database per user (default in ~/.sat.db, we don't follow XDG base directory specifications yet); it is updated automatically if there is a schema change.
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 ##############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
113 Contrat social
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
114 ##############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
115
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
116 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
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 #############
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
120 Miscellaneous
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
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
123 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.
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
124 The translations are global to all the frontends (no translations available in Libervia yet). There are not up-to-date for 0.4 version.
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
7565d3ac0a96 misc: README4PACKAGERS improvments
Matteo Cypriani <mcy@lm7.fr>
parents: 896
diff changeset
127 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).