Mercurial > libervia-pubsub

comparison doc/installation.rst @ 421:f124ed5ea78b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: remove python2 references + added a warning for `python setup.py install`
author Goffi <goffi@goffi.org>
date Sat, 22 Feb 2020 13:06:51 +0100
parents f527dc927a6a
children 968091cea547
comparison
equal deleted inserted replaced
420:7a43c039c261 421:f124ed5ea78b
2 Installation 2 Installation
3 ============ 3 ============
4 4
5 This are the instructions to install SàT Pubsub. 5 This are the instructions to install SàT Pubsub.
6 6
7 Please note that SàT PubSub, as all SàT ecosystem, is still using Python 2 (this will
8 change for SàT PubSub 0.4 version which will be Python 3 only), so all instructions below
9 have to be made using python 2.
10
11 .. note:: 7 .. note::
12 8
13 SàT PubSub is not released yet and this documentation is work in progress 9 SàT PubSub is not released yet and this documentation is work in progress
14 10
15 11
16 Requirements 12 Requirements
17 ------------ 13 ------------
18 14
19 - Python 2.7.x 15 - Python 3.7+
20 - Twisted >= 15.2.0: 16 - Twisted >= 15.2.0:
21 - Twisted Core 17 - Twisted Core
22 - Twisted Words 18 - Twisted Words
23 - Wokkel >= 0.7.1 (http://wokkel.ik.nu/) 19 - Wokkel >= 0.7.1 (http://wokkel.ik.nu/)
24 - A XMPP server that supports the component protocol (XEP-0114), 20 - A XMPP server that supports the component protocol (XEP-0114),
43 39
44 Now go in a location where you can install SàT Pubsub, for instance your home directory:: 40 Now go in a location where you can install SàT Pubsub, for instance your home directory::
45 41
46 $ cd 42 $ cd
47 43
48 And enter the following commands (note that *virtualenv2* may be named 44 And enter the following commands::
49 *virtualenv* on some distributions, just be sure it's Python **2** version):: 45
50 46 $ python3 -m venv env
51 $ virtualenv2 env
52 $ source env/bin/activate 47 $ source env/bin/activate
53 $ pip install hg+https://repos.goffi.org/sat_pubsub 48 $ pip install hg+https://repos.goffi.org/sat_pubsub
49
50 .. note::
51
52 If your are installing from a local clone of the repository, it has been reported that
53 installation with ``python setup.py install`` is not working properly. Please use ``pip
54 install .`` instead.
55
54 56
55 Post Installation 57 Post Installation
56 ----------------- 58 -----------------
57 59
58 Once SàT Pubsub is installed, you'll need to create a PostgreSQL user, and create the 60 Once SàT Pubsub is installed, you'll need to create a PostgreSQL user, and create the