Skip to content
This repository was archived by the owner on Mar 2, 2022. It is now read-only.

Commit f138544

Browse files
committed
Add installation system requirements and Python version
1 parent 80d0285 commit f138544

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ This project is still under active development and is not ready for active use o
1515
Installation
1616
------------
1717

18+
BWScanner is not yet compatible with Python 3 due to the `txsocksx ` dependency.
19+
20+
In Debian/Ubuntu systems, you can install Python 2 and other systems
21+
requirements running:
22+
23+
.. code:: bash
24+
25+
sudo apt install python2.7 python2.7-dev
26+
1827
The bandwidth scanner and its dependencies can be installed as follows:
1928

2029
.. code:: bash
@@ -23,11 +32,20 @@ The bandwidth scanner and its dependencies can be installed as follows:
2332
cd bwscanner
2433
python setup.py install
2534
35+
In case your system is using Python 3 by default, you need to run Python 2
36+
explicitely, changing last line by:
37+
38+
.. code:: bash
39+
40+
python2.7 setup.py install
41+
42+
2643
Running
2744
-------
2845

2946
After installation the ``bwscan`` tool should be available in your path. This tool has a number of subcommands for running scans and for aggregating the collected data for use by the bandwidth authorities.
3047

48+
3149
Collecting bandwidth measurements
3250
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3351

0 commit comments

Comments
 (0)