tor-commits September 2018

tor-commits@lists.torproject.org

17 participants
3230 discussions

[sbws/master] Add examples of contributions
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit add6e11280cd64c0a178bacd435fd4da05480b85 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:21:09 2018 +0000 Add examples of contributions --- CONTRIBUTING.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 560f8b7..15b8ff5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,8 +1,12 @@ Contributing to Simple Bandwidth Scanner ---------------------------------------- -Thank you for your interest in Simple Bandwidth Scanner (sbws). +Thank you for your interest in Simple Bandwidth Scanner (``sbws``). +Examples of contributions include: + +* Bug reports +* Code/documentation patches Pull requests are welcome, especially if they address open issues.

1 0

[sbws/master] Change section header as in other pages
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 89f3a5741115a79e2a1d148f05217e87e73f1123 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:23:23 2018 +0000 Change section header as in other pages --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 15b8ff5..a2134e0 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,5 +1,5 @@ Contributing to Simple Bandwidth Scanner ----------------------------------------- +========================================= Thank you for your interest in Simple Bandwidth Scanner (``sbws``).

1 0

[sbws/master] Add reference to sbws man page
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 09065ea745a3073bd56476e9b843d2f24a91fd93 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:11:54 2018 +0000 Add reference to sbws man page --- DEPLOY.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/DEPLOY.rst b/DEPLOY.rst index 1e56924..8d4a9ce 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -32,3 +32,5 @@ They are not included by default. To configure destinations, create a configuration file according to :doc:`man_sbws.ini` + +See also :doc:`sbws.ini` manual page.

1 0

[sbws/master] Use same license as setup.py
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 89d9cca0e429d70e5ec41785a4bb8d5a8db27d1f Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:57:42 2018 +0000 Use same license as setup.py --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d65a209..304c6a6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -24,7 +24,7 @@ def find_version(): # -- Project information ----------------------------------------------------- project = 'Simple Bandwidth Scanner' -copyright = 'Public Domain' +copyright = 'CC0' author = 'Matt Traudt [sirmatt at ksu dot edu], juga [juga at riseup dot net]' # The short X.Y version

1 0

[sbws/master] Add bandwidth-file-spec in see also
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 9a7989d7a647c211d678f71f998fb35260e4197e Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:54:42 2018 +0000 Add bandwidth-file-spec in see also --- docs/source/man_sbws.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 9d4b164..9636698 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -87,7 +87,8 @@ $XDG_RUNTIME_DIR/sbws SEE ALSO --------- -**sbws.ini** (5), https://sbws.readthedocs.org. +**sbws.ini** (5), https://sbws.readthedocs.org, +https://gitweb.torproject.org/torspec.git/tree/bandwidth-file-spec.txt. BUGS ----

1 0

[sbws/master] Add authors
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit a87e2fe823e5234b22a0004b487f3f644548c74a Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:08:11 2018 +0000 Add authors --- setup.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 7985eac..9db8731 100755 --- a/setup.py +++ b/setup.py @@ -45,8 +45,8 @@ setup( description='Simple Bandwidth Scanner', long_description=long_description(), long_description_content_type="text/markdown", - author='Matt Traudt', - author_email='pastly(a)torproject.org', + author='Matt Traudt, juga', + author_email='{pastly, juga}(a)torproject.org', license='CC0', url="https://gitweb.torproject.org/sbws.git", classifiers=[

1 0

[sbws/master] Change doc name to match repo/package
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit aab743cd3f41ebe68e56689514427fe29d3c099c Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:01:25 2018 +0000 Change doc name to match repo/package --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 304c6a6..aa8ffca 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -23,7 +23,7 @@ def find_version(): # -- Project information ----------------------------------------------------- -project = 'Simple Bandwidth Scanner' +project = 'sbws' copyright = 'CC0' author = 'Matt Traudt [sirmatt at ksu dot edu], juga [juga at riseup dot net]'

1 0

[sbws/master] Move testing docs to testing file
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit b132f8c1897413e23d341817397d7bb0248e4034 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:47:20 2018 +0000 Move testing docs to testing file --- INSTALL.rst | 19 ------------------- TESTING.rst | 19 +++++++++++++++++++ 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 9d5c8f5..5832f3b 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -48,25 +48,6 @@ Install the python dependencies:: ``sbws`` needs :term:`destination` s to request files from. Please, see :ref:`deploy` to know how to configure, deploy and run ``sbws``. -Installing tests dependencies and running them ------------------------------------------------- - -To run the tests, extra Python depenencies are needed: - -- Flake8_ -- tox_ -- pytest_ -- coverage_ - -To install them from ``sbws`` :: - - pip install .[dev] && pip install .[test] - -To run the tests:: - - tox - - Installing documentation dependendencies and building it --------------------------------------------------------- diff --git a/TESTING.rst b/TESTING.rst new file mode 100644 index 0000000..a75aeaa --- /dev/null +++ b/TESTING.rst @@ -0,0 +1,19 @@ +.. _testing: + +Installing tests dependencies and running tests +================================================== + +To run the tests, extra Python depenencies are needed: + +- Flake8_ +- tox_ +- pytest_ +- coverage_ + +To install them from ``sbws`` :: + + pip install .[dev] && pip install .[test] + +To run the tests:: + + tox

1 0

[sbws/master] Remove license note, it is in README
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit b46ab1b89d56d9938e28472286a78e34da204202 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 18:14:31 2018 +0000 Remove license note, it is in README --- CONTRIBUTING.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2b70c13..560f8b7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -3,12 +3,6 @@ Contributing to Simple Bandwidth Scanner Thank you for your interest in Simple Bandwidth Scanner (sbws). -.. note:: - - Simple Bandwidth Scanner is in the public domain according to its - :doc:`CC0 license </LICENSE>`. No one has copyright over sbws, though we - update the list of :doc:`authors </AUTHORS>` from time to time. - Pull requests are welcome, especially if they address open issues.

1 0

[sbws/master] Rephrase and extend code style and PR steps
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 2b9b1158c919c817951b0ebe8a68a8e2839592e2 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 17:17:16 2018 +0000 Rephrase and extend code style and PR steps --- CONTRIBUTING.rst | 68 +++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 57 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b109ee5..b2b96eb 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -23,29 +23,75 @@ The sbws canonical repository is https://gitweb.torproject.org/sbws.git, but we review patches using the Github canonical repository (https://github.com/torproject/sbws) Pull Requests (PR). -Steps: +To know more about ``sbws`` code, -1. Create a ticket in Tor Project Trac as explained above +.. seealso:: + + - :ref:`dev_doc` + - ``./docs/source/testing.rst`` (or `testing </docs/source/testing.rst>`_ + or :ref:`testing`). + - ``./docs/source/documenting.rst`` (or `documenting </docs/source/documenting.rst>`_ + or :ref:`documenting`). + +The following are guidelines we aim to follow. + +Steps to create a PR +~~~~~~~~~~~~~~~~~~~~~ + +1. Create a ticket in Tor Project Trac (:ref:`Open ticket <ticket-ref>`) 2. Clone ``sbws`` via the Github web interface https://github.com/torproject/sbws 3. Clone the repository locally -4. Install ``sbws`` as explained in ./INSTALL.rst and TESTING.rst +4. Install ``sbws`` as explained in ./INSTALL.rst and ./TESTING.rst Use ``pip install -e <>`` 5. If needed install the documentation and build it as explained in ./DOCUMENTATION.rst 6. Create a new branch, named ``ticketXXX``. Optionally, name it with a string explaining what it does, ie ``ticketXXX_contributing`` -7. Write code, create tests, commit, etc. -8. Ensure tests pass. -9. Create a PR from your branch to https://github.com/torproject/sbws -10. Change the ticket status to ``needs_review`` +7. Write code (:ref:`codestyle-ref`), tests, documentation, + extra files (:ref:`extrafiles-ref`), commit (:ref:`commits-ref`), etc. +8. Ensure tests pass (./TESTING.rst). +9. Push your branch to your repository. If you have an account in Travis, + you can see whether it pass the tests in Github and in + https://travis-ci.org/youruser/sbws/ +10. Create a PR from your branch to https://github.com/torproject/sbws +11. Change the Trac ticket status to ``needs_review`` + +.. _codestyle-ref: + +Code style +~~~~~~~~~~ + +Follow the Zen of Python (:pep:`20`) + +.. code-block:: pycon + + >>> import this + The Zen of Python, by Tim Peters + + Beautiful is better than ugly. + Explicit is better than implicit. + Simple is better than complex. + Complex is better than complicated. + Flat is better than nested. + Sparse is better than dense. + Readability counts. + +Code should adhere to the :pep:`8` guidelines. +Before release 1.0.0, some guidelines have not been followed, +such as the ordering the inputs (:pep:`8#imports`). + +Any non-trivial change should contain tests. See ./TESTING.rst. +When running tests, currently ``flake8`` informs on some PEP8 errors/warnings, +but not all. -We use flake8 to check some PEP8 errors/warnings. This will be checked with -``tox`` and Travis. +All functions, methods and classes should have :pep:`0257` +(except ``__repr__`` and ``__str__``). +Before release 1.0.0, some docstrigs do not have 3 double quotes ``"""`` +(:pep:`0257#id15`). -Simple Bandwidth Scanner is moving towards 100% test coverage. Please help us -reach that goal, or at least not move us away from it. +New features should add a corresponding documentation. Git and GitHub Guidelines =========================

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits September 2018