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

[sbws/master] Delete config.ini from documentation
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 3cfb8dd5d0fe0de3228ffe054203da6a02fd3f77 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 19:20:27 2018 +0000 Delete config.ini from documentation and add config.example.ini --- docs/source/config.example.ini | 10 ++++++++++ docs/source/config.ini | 2 -- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/source/config.example.ini b/docs/source/config.example.ini new file mode 100644 index 0000000..f3ca1da --- /dev/null +++ b/docs/source/config.example.ini @@ -0,0 +1,10 @@ +# Minimum configuration that needs to be customized +[scanner] +# A human-readable string with chars in a-zA-Z0-9 to identify your scanner +nickname = sbws_default + +[destinations] +foo = off + +[destinations.foo] +url = https://example.com/does/not/exist.bin diff --git a/docs/source/config.ini b/docs/source/config.ini deleted file mode 100644 index 1b4cf26..0000000 --- a/docs/source/config.ini +++ /dev/null @@ -1,2 +0,0 @@ -[paths] -sbws_home = /home/user/.sbws

1 0

[sbws/master] Update doc with config files changes
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit cd50bc496ce33a8f6faa5349df05c28a7df6c7e6 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 19:22:16 2018 +0000 Update doc with config files changes --- docs/source/config.rst | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/docs/source/config.rst b/docs/source/config.rst index 723949d..495fbff 100644 --- a/docs/source/config.rst +++ b/docs/source/config.rst @@ -1,12 +1,25 @@ Simple Bandwidth Scanner Configuration Files ============================================ -Sbws has three config files it reads: two general, and one specific to logging. -They all get combined internally to the same ``conf`` structure, so technically -you can put any option in any file, but you need to pay attention to the order -in which they are read. Options specified in multiple files will take the -values set in the last-read file. **It's best to only put options in the files -you are meant to put them in.** +How to create user customized configuration files +-------------------------------------------------- +``sbws`` use internal configuration files. +These are **not** intented to be modified by a user. +If a user needs a customized configuration file, the user needs to create it. +There's an example configuration file with the minimum data that a user +probably needs to edit in ``examples``. For more advanced configuration options see +documentation below. +``sbws`` will check by default whether there's a user customized file in +``~/sbws.ini`` and use it when it exists. +The user can store a customized configuration file anywhere else in the file +system and and provide ``sbws`` with the path to it via the ``-c`` or +``--config`` cli option. + +How sbws configuration works internally +---------------------------------------- +Sbws has two default config files it reads: on general, and one specific to +logging. +They all get combined internally to the same ``conf`` structure. It first reads the config file containing the default values for almost all options. If you installed sbws in a virtual environment located at /tmp/venv, @@ -21,16 +34,16 @@ previous file. The contents of this default log config file can be found :ref:`at the bottom of this page <default-log-config>`. Options set here overwrite options set in the previous config file. -Sbws then reads your custom config file. By default, after running ``sbws -init``, it is located in ``~/.sbws/config.ini``. Options in this -file overwrite options set in previously read config files. +Sbws then reads your custom config file. By default, it will search for it +in ``~/.sbws.ini``. Options in this file overwrite options set in previously +read config files. -After running ``sbws init``, your ``~/.sbws/config.ini`` might look like this. +The user example config file provided by ``sbws`` might look like this. .. _init-config: -.. literalinclude:: config.ini - :caption: Example ~/.sbws/config.ini +.. literalinclude:: config.example.ini + :caption: Example config.example.ini **No other configuration files are read.**

1 0

[sbws/master] Include examples
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit f027ac4bd5720a30e2d164c8547d2a60d83a3304 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 18:41:09 2018 +0000 Include examples --- MANIFEST.in | 1 + 1 file changed, 1 insertion(+) diff --git a/MANIFEST.in b/MANIFEST.in index 9d1ecc2..332cfc4 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,7 @@ include *.md include *.rst include sbws/*.ini +include examples * recursive-include docs * prune docs/build recursive-include tests *

1 0

[sbws/master] Replace conf['paths'] by conf.getpath('paths'
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 3a4b2c0ef72bc3d4e554910e8278cf667711c744 Author: juga0 <juga(a)riseup.net> Date: Thu Aug 2 17:44:44 2018 +0000 Replace conf['paths'] by conf.getpath('paths' --- sbws/core/generate.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sbws/core/generate.py b/sbws/core/generate.py index 2055189..f10ecc1 100644 --- a/sbws/core/generate.py +++ b/sbws/core/generate.py @@ -59,6 +59,7 @@ def main(args, conf): 'ran sbws scanner recently?)') return bw_file = V3BWFile.from_arg_results(args, conf, results) - output = args.output or conf['paths']['v3bw_fname'].format(now_fname()) + output = args.output or \ + conf.getpath('paths', 'v3bw_fname').format(now_fname()) bw_file.write(output) log.info('Mean bandwidth per line: %f "KiB"', bw_file.avg_bw)

1 0

[sbws/master] Update docstring, it does not create user conf
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 849f2c3fd584616f2caa42dad71b035fde9c95f6 Author: juga0 <juga(a)riseup.net> Date: Thu Aug 2 17:46:29 2018 +0000 Update docstring, it does not create user conf --- sbws/util/config.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/sbws/util/config.py b/sbws/util/config.py index d6bb115..9532bdc 100644 --- a/sbws/util/config.py +++ b/sbws/util/config.py @@ -48,9 +48,8 @@ def _get_default_config(): def _get_user_config(args, conf=None): """Get user configuration. - If a custom path is passed, search for user configuration there. - In any case, create a minimal user configuration in user configuration path - , in case it needs to be overwritten. + Search for user configuration in the default path or the path passed as + argument and extend the configuration if they are found. """ if not conf: conf = ConfigParser(interpolation=ExtendedInterpolation(),

1 0

[sbws/master] Replace conf['paths'] by conf.getpath('paths'
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 036cc7f239a4605126cb3311e2cbfa2efc52dbcc Author: juga0 <juga(a)riseup.net> Date: Thu Aug 2 17:45:48 2018 +0000 Replace conf['paths'] by conf.getpath('paths' --- sbws/lib/v3bwfile.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sbws/lib/v3bwfile.py b/sbws/lib/v3bwfile.py index 620cdb8..ad3e2e2 100644 --- a/sbws/lib/v3bwfile.py +++ b/sbws/lib/v3bwfile.py @@ -194,7 +194,7 @@ class V3BWHeader(object): ISO formatted timestamp for the time when the scanner process most recently started. ''' - state = State(conf['paths']['state_fname']) + state = State(conf.getpath('paths', 'state_fname')) if 'scanner_started' in state: return state['scanner_started'] else:

1 0

[sbws/master] sbws default user conf starts by .
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 4f377d3b2edb1c55d470324adf000faa58078be6 Author: juga0 <juga(a)riseup.net> Date: Thu Aug 2 17:47:18 2018 +0000 sbws default user conf starts by . --- docs/source/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/config.rst b/docs/source/config.rst index 495fbff..2a0c7f9 100644 --- a/docs/source/config.rst +++ b/docs/source/config.rst @@ -10,7 +10,7 @@ There's an example configuration file with the minimum data that a user probably needs to edit in ``examples``. For more advanced configuration options see documentation below. ``sbws`` will check by default whether there's a user customized file in -``~/sbws.ini`` and use it when it exists. +``~/.sbws.ini`` and use it when it exists. The user can store a customized configuration file anywhere else in the file system and and provide ``sbws`` with the path to it via the ``-c`` or ``--config`` cli option.

1 0

[sbws/master] Remove instead init documentation
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit acd9cdb948c46d10e88823e51d73de192a139ea5 Author: juga0 <juga(a)riseup.net> Date: Thu Aug 2 17:50:02 2018 +0000 Remove instead init documentation --- docs/source/sbws.core.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/source/sbws.core.rst b/docs/source/sbws.core.rst index 4d71f1f..72a52b0 100644 --- a/docs/source/sbws.core.rst +++ b/docs/source/sbws.core.rst @@ -20,14 +20,6 @@ sbws.core.generate module :undoc-members: :show-inheritance: -sbws.core.init module -~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: sbws.core.init - :members: - :undoc-members: - :show-inheritance: - sbws.core.scanner module ~~~~~~~~~~~~~~~~~~~~~~~~

1 0

[sbws/master] Revert "Remove init from documentation"
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 7d5a00988599b5ff86a5ec7667a5629a92dddbab Author: juga0 <juga(a)riseup.net> Date: Thu Aug 2 17:47:36 2018 +0000 Revert "Remove init from documentation" This reverts commit b91697cc3eb5badabd3a1cc16430ab6a28f648ea. Removed by mistake --- docs/source/sbws.core.rst | 54 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/docs/source/sbws.core.rst b/docs/source/sbws.core.rst new file mode 100644 index 0000000..4d71f1f --- /dev/null +++ b/docs/source/sbws.core.rst @@ -0,0 +1,54 @@ +sbws.core package +===================== + +Submodules +---------- + +sbws.core.cleanup module +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: sbws.core.cleanup + :members: + :undoc-members: + :show-inheritance: + +sbws.core.generate module +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: sbws.core.generate + :members: + :undoc-members: + :show-inheritance: + +sbws.core.init module +~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: sbws.core.init + :members: + :undoc-members: + :show-inheritance: + +sbws.core.scanner module +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: sbws.core.scanner + :members: + :undoc-members: + :show-inheritance: + +sbws.core.stats module +~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: sbws.core.stats + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: sbws.core + :members: + :undoc-members: + :show-inheritance:

1 0

[sbws/master] Drop support for python 3.4
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit f82da2e10433cdcf92526c96590977fd1b9de8d4 Author: juga0 <juga(a)riseup.net> Date: Fri Aug 3 11:02:24 2018 +0000 Drop support for python 3.4 --- tox.ini | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tox.ini b/tox.ini index 36d9283..bf86c65 100644 --- a/tox.ini +++ b/tox.ini @@ -1,11 +1,10 @@ [tox] skip_missing_interpreters = True -envlist = clean, lint, py34, py35, py36, integration, stats +envlist = clean, lint, py35, py36, integration, stats [travis] python = - 3.4: lint, py34, integration - 3.5: py35, integration + 3.5: lint, py35, integration 3.6: py36, integration [testenv:clean]

1 0