changeset 421:f124ed5ea78b

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 7a43c039c261
children c21f31355ab9
files doc/installation.rst
diffstat 1 files changed, 10 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/installation.rst	Sat Dec 28 19:57:02 2019 +0100
+++ b/doc/installation.rst	Sat Feb 22 13:06:51 2020 +0100
@@ -4,10 +4,6 @@
 
 This are the instructions to install SàT Pubsub.
 
-Please note that SàT PubSub, as all SàT ecosystem, is still using Python 2 (this will
-change for SàT PubSub 0.4 version which will be Python 3 only), so all instructions below
-have to be made using python 2.
-
 .. note::
 
    SàT PubSub is not released yet and this documentation is work in progress
@@ -16,7 +12,7 @@
 Requirements
 ------------
 
-- Python 2.7.x
+- Python 3.7+
 - Twisted >= 15.2.0:
    - Twisted Core
    - Twisted Words
@@ -45,13 +41,19 @@
 
     $ cd
 
-And enter the following commands (note that *virtualenv2* may be named
-*virtualenv* on some distributions, just be sure it's Python **2** version)::
+And enter the following commands::
 
-    $ virtualenv2 env
+    $ python3 -m venv env
     $ source env/bin/activate
     $ pip install hg+https://repos.goffi.org/sat_pubsub
 
+.. note::
+
+   If your are installing from a local clone of the repository, it has been reported that
+   installation with ``python setup.py install`` is not working properly. Please use ``pip
+   install .`` instead.
+
+
 Post Installation
 -----------------