September 2018 - tor-commits - lists.torproject.org

[sbws/master] Add all the system requirements
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 3c4dfeb8069270b525c30bca26535db1e8c6b852 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 15:00:01 2018 +0000 Add all the system requirements --- INSTALL.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 1ccfa1b..b61c642 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -3,13 +3,18 @@ Installing Simple Bandwidth Scanner =================================== -(At the time of writing) sbws depends on two Python libraries. - -- Stem_ -- Requests_ - -Sbws relies on a stem feature that is not planned to be in a tagged release -until stem 1.7.0. +The prefered method to install ``sbws`` is to install it from your system +distribution. +Currently there is not any system distribution package. +In the meanwhile, follow the following steps. + +System requirements +-------------------- + +- Tor +- Python 3 +- virtualenv_ (while there is not ``stem`` release > 1.6.0, it is + recommended to install the required python dependencies in a virtualenv) Read all the information for the installation method of your choice before beginning. Often you will want to be armed with the knowledge of the latest

1 0

[sbws/master] Explain where config should create and where to find doc about it
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 18039b8060dbf4665154b059b64350b3fd239095 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:55:54 2018 +0000 Explain where config should create and where to find doc about it --- DEPLOY.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index 4411d85..ea20302 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -29,14 +29,15 @@ Install sbws according to :doc:`/INSTALL`. ``sbws`` needs :term:`destination` (s) to request files from. They are not included by default. -Inside |dotsbws| you will find ``config.ini``. Open it with a text editor. it -should be very simple. Let's give our scanner a nickname. Add the following -lines +To configure destinations, create a file called ``config.ini``. It can be +located in: -:: +* ``~/.sbws/`` if you are running ``sbws`` manually +* ``/etc/sbws`` if you are running ``sbws`` from a system package as a + ``systemd`` directory (not yet supported) +* any localion, an specify the path via the ``-c`` argument - [scanner] - nickname = D0ntD3@dOpen!nside +And edit destinations according to :doc:`man_sbws.ini` (Pick your own nickname. This one just demonstrates that you can use almost any character)

1 0

[sbws/master] Specify what is nickname is optional
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit adee13d12da114a07e9ff185dc314467f27484ab Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:56:47 2018 +0000 Specify what is nickname is optional --- DEPLOY.rst | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index ea20302..f94e0f7 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -39,16 +39,10 @@ located in: And edit destinations according to :doc:`man_sbws.ini` -(Pick your own nickname. This one just demonstrates that you can use almost any -character) +It is not required, but it is recomended to include a custom scanner +``nickname`` in ``config.ini``. -Congratulations, you've learned how to add a section to your config file and -how to add an option to a section. - -Remeber |dests|? We need to add them to ``config.ini``. We're going to assume -you have two you are ready to use and one that isn't quite ready yet. - -:: +Destination(s) configuration in more detail:: [destinations] foo = on

1 0

[sbws/master] Remove versions and just clone sbws
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 6a1668c62182761fa00980906e6ef6ea74726dc6 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 15:06:40 2018 +0000 Remove versions and just clone sbws --- INSTALL.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 7c74c0f..dd0dc2f 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -33,13 +33,9 @@ To install the Python dependencies, create a ``virtualenv`` first virtualenv venv -p /usr/bin/python3 source venv/bin/activate -Install stem in virtualenv -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Clone ``sbws``:: -Sbws requires on features not yet in a released version of stem (1.7.0 has not -been released as of the time of writing). You can either install from the -master branch, or checkout ``60f034ad8b9c3aa48e7e2ecb0a2e159b6ed5bc71`` or -newer. + git clone https://gitweb.torproject.org/sbws.git ::

1 0

[sbws/master] Add python dependencies
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 2042e36527c3a64e00554a1fb882383247d067d4 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 15:05:12 2018 +0000 Add python dependencies --- INSTALL.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 4122e4a..2c7d2f3 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -20,9 +20,11 @@ In Debian:: sudo apt install tor python3 virtualenv +Python dependencies +-------------------- -Create and enter virtualenv -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- Stem_ > 1.6.0 +- Requests_ (with socks_ support) >= 2.10.0 I like to keep mine in my simple-bw-scanner directory and assume that's where you'll put it.

1 0

[sbws/master] Explain how to run tests
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 52d4e7d4ae9564a305cce0904a3b0920a73bbff4 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 15:09:43 2018 +0000 Explain how to run tests --- INSTALL.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 4041223..9eac885 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -62,10 +62,9 @@ To install them from ``sbws`` :: pip install .[dev] && pip install .[doc] - Because we relay on a ``-dev`` version of stem, we need to fetch it from - git.torproject.org. Thus ``--process-dependency-links`` is necessary. +To run the tests:: -.. warning:: + tox Run these commands one at a time and check for errors before continuing.

1 0

[sbws/master] Remove versions and install python dependencies with pip
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit d3f5dd202c57ae68e2e8aea59b535dc5b3967674 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 15:07:35 2018 +0000 Remove versions and install python dependencies with pip --- INSTALL.rst | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index dd0dc2f..21e8fbd 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -37,22 +37,13 @@ Clone ``sbws``:: git clone https://gitweb.torproject.org/sbws.git -:: - - pip install ../stem - -Install sbws and its remaining dependencies -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Install the python dependencies:: -Here is where you might want to know what the latest release of sbws is (this -document assumes it is 1.5.3). Skip -the ``git checkout`` if you want to run the bleeding edge tip-of-master version -of sbws. + cd sbws && pip install --process-dependency-links . -:: - - git checkout v1.5.3 - pip install . +.. note:: ``process-dependency-links`` will clone ``stem`` from master and + install it. It's deprecated, but it won't be needed as soon as there is + an ``stem`` release > 1.6.0 Run sbws ~~~~~~~~~~

1 0

[sbws/master] Use domains reserved for examples
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 5e7ff7303eccb0996e221bded92ba7b0fe06682a Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:57:37 2018 +0000 Use domains reserved for examples --- DEPLOY.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index f94e0f7..5ed375b 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -50,13 +50,13 @@ Destination(s) configuration in more detail:: baz = off [destinations.foo] - url = http://fooshoomoo.com/sbws.bin + url = http://example.org/sbws.bin [destinations.bar] - url = https://barstoolsinc.com + url = https://example.com [destinations.baz] - url = https://bazistan.com/ask/stan/where/the/file/is.exe + url = https://example.net/ask/stan/where/the/file/is.exe ``foo`` demonstrates a typical case.

1 0

[sbws/master] Add extra dependencies for docs. Remove obsolete
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit f92a10276157c1fa9437322e48eabe47b25fbfff Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 15:11:10 2018 +0000 Add extra dependencies for docs. Remove obsolete --- INSTALL.rst | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 9eac885..f83489d 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -66,27 +66,19 @@ To run the tests:: tox - Run these commands one at a time and check for errors before continuing. -Updating -~~~~~~~~ - -:: +Installing documentation dependendencies and building it +--------------------------------------------------------- - cd simple-bw-scanner - git pull - # Determine the newest released version. Assuming it is v1.5.3 ... - git checkout v1.5.3 - source venv/bin/activate - pip install --process-dependency-links --upgrade-strategy eager --upgrade . +To build the documentation, extra Python dependencies are needed: +- Sphinx_ +- recommonmark_ +- Pylint_ (only to update the diagrams) -[OBSOLETE DO NOT FOLLOW] Virtualenv - Development ------------------------------------------------------------------------------- +To install them from ``sbws``:: -These are almost exactly the same. The difference is the pip command: we -install sbws in an editable state so we don't have to re-run pip every time we -make a change. + pip install .[doc] ::

1 0

[sbws/master] Remove unneed steps, include system dependencies example
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit d42c53080b7ab35bc60d823e5fbc8565f62c66c5 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 15:04:20 2018 +0000 Remove unneed steps, include system dependencies example --- INSTALL.rst | 30 ++---------------------------- 1 file changed, 2 insertions(+), 28 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 1c6775e..4122e4a 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -16,35 +16,9 @@ System requirements - virtualenv_ (while there is not ``stem`` release > 1.6.0, it is recommended to install the required python dependencies in a virtualenv) +In Debian:: -.. _Stem: https://stem.torproject.org/ -.. _Requests: http://docs.python-requests.org/ - -.. _release page: https://github.com/pastly/simple-bw-scanner/releases - -Virtualenv - Development ------------------------------------------------------------------------------- - -Choose a directory to store code in. I might choose ``~/src``. - -:: - - cd ~/src - -Get stem -~~~~~~~~~~~~~ - -:: - - git clone https://git.torproject.org/stem.git - -Get sbws -~~~~~~~~~~~~~~~~~ - -:: - - git clone https://github.com/pastly/simple-bw-scanner.git - cd simple-bw-scanner + sudo apt install tor python3 virtualenv Create and enter virtualenv

1 0