commit 18d992abbfdf4a0110bd9c36950c52470d2f5f3c
Author: juga0 <juga(a)riseup.net>
Date: Tue Aug 28 15:08:01 2018 +0000
Add refernce to deploy
---
INSTALL.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/INSTALL.rst b/INSTALL.rst
index 21e8fbd..2fccc46 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -45,8 +45,8 @@ Install the python dependencies::
install it. It's deprecated, but it won't be needed as soon as there is
an ``stem`` release > 1.6.0
…
[View More]
-Run sbws
-~~~~~~~~~~
+``sbws`` needs :term:`destination` s to request files from.
+Please, see :ref:`deploy` to know how to configure, deploy and run ``sbws``.
If you would like to use a custom configuration file you can create it in
``~/.sbws.ini`` or provide ``sbws`` with it via ``-c`` ``--config`` option.
[View Less]
commit b199c3afa122f77201299c05b23be501cc0cd16b
Author: juga0 <juga(a)riseup.net>
Date: Tue Aug 28 15:09:08 2018 +0000
Add extra dependencies for tests. Remove obsolete
---
INSTALL.rst | 34 +++++++++-------------------------
1 file changed, 9 insertions(+), 25 deletions(-)
diff --git a/INSTALL.rst b/INSTALL.rst
index 2fccc46..4041223 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -48,35 +48,19 @@ Install the python dependencies::
``sbws`` needs :term:`destination` s to request …
[View More]files from.
Please, see :ref:`deploy` to know how to configure, deploy and run ``sbws``.
-If you would like to use a custom configuration file you can create it in
-``~/.sbws.ini`` or provide ``sbws`` with it via ``-c`` ``--config`` option.
+Installing tests dependencies and running them
+------------------------------------------------
-See the documentation section about configuration files for more information
-about how to create a configuration file.
+To run the tests, extra Python depenencies are needed:
-Tor run the scanner run
-::
-
- sbws scanner
-
-
-[OBSOLETE DO NOT FOLLOW] Virtualenv - Production
-------------------------------------------------------------------------------
-
-Installing
-~~~~~~~~~~
-
-::
+- Flake8_
+- tox_
+- pytest_
+- coverage_
- git clone https://github.com/pastly/simple-bw-scanner.git
- cd simple-bw-scanner
- git checkout v1.5.3
- virtualenv -p python3 venv
- source venv/bin/activate
- pip install --process-dependency-links .
- sbws init
+To install them from ``sbws`` ::
-.. note::
+ 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.
[View Less]
commit a0f750566b85458ab92bb3250efca12afd246899
Author: juga0 <juga(a)riseup.net>
Date: Tue Aug 28 15:02:27 2018 +0000
Remove paragraph about versions
---
INSTALL.rst | 5 -----
1 file changed, 5 deletions(-)
diff --git a/INSTALL.rst b/INSTALL.rst
index b61c642..1c6775e 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -16,11 +16,6 @@ System requirements
- virtualenv_ (while there is not ``stem`` release > 1.6.0, it is
recommended to install the required python dependencies in …
[View More]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
-released version of sbws. Determine that by examining its git tags, or visiting
-its `release page`_. In the remainder of this document, we assume the latest
-version is 1.5.3, which would be tagged as ``v1.5.3``.
.. _Stem: https://stem.torproject.org/
.. _Requests: http://docs.python-requests.org/
[View Less]
commit 2303b06399edb4a976872b491d0cde6d62c35dbe
Author: juga0 <juga(a)riseup.net>
Date: Tue Aug 28 15:12:46 2018 +0000
And remove it from README
---
README.md | 8 --------
1 file changed, 8 deletions(-)
diff --git a/README.md b/README.md
index ddf4d20..6febd3a 100644
--- a/README.md
+++ b/README.md
@@ -111,14 +111,6 @@ how its code is laid out. Therefore the code may change drastically without a
major version bump as long as the way users interact with it does not change in
a …
[View More]backward incompatible way.
-### Build HTML documentation
-
- pip install -e .[doc]
- cd docs
- make html
-
-The generated HTML will be in `docs/build/`.
-
## The `.sbws` directory
By default is `~/.sbws`.
[View Less]
commit 59b42b085931c44fb474753e04cead8bc8945de8
Author: juga0 <juga(a)riseup.net>
Date: Tue Aug 28 15:10:23 2018 +0000
And remove it from README
---
README.md | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/README.md b/README.md
index 7072f8b..ddf4d20 100644
--- a/README.md
+++ b/README.md
@@ -133,12 +133,3 @@ In this directory you will find
- `v3bw/` This directory stores the v3bw files created with `sbws generate`.
- `state.dat` A file for storing state needed …
[View More]between sbws commands. See its
documentation for more information.
-
-## Running tests
-
-Make sure you have test dependencies installed. From within the top level
-repository directory:
-
- pip install -e .[test]
-
-This should install tox and pytest. Then simply run `tox`.
[View Less]
commit b16d5c0113c7bfe299336ddc2515e5f1c5ff8247
Author: juga0 <juga(a)riseup.net>
Date: Tue Aug 28 15:11:56 2018 +0000
Explain how to build docs. Remove obsolete
---
INSTALL.rst | 31 +++++++++----------------------
1 file changed, 9 insertions(+), 22 deletions(-)
diff --git a/INSTALL.rst b/INSTALL.rst
index f83489d..b774ae2 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -80,35 +80,22 @@ To install them from ``sbws``::
pip install .[doc]
-::
-
- git clone https://…
[View More]github.com/pastly/simple-bw-scanner.git
- cd simple-bw-scanner
- git checkout v1.5.3
- virtualenv -p python3 venv-editable
- source venv-editable/bin/activate
- pip install --process-dependency-links --editable .
- sbws init
+To build the documentation as HTML::
-.. note::
+ cd docs/ && make html
- Because we relay on a ``-dev`` version of stem, we need to fetch it from
- git.torproject.org. Thus ``--process-dependency-links`` is necessary.
+The generated HTML will be in `docs/build/`.
-.. warning::
+To build the manual (``man``) pages::
- Run these commands one at a time and check for errors before continuing.
+ cd docs/ && make man
-Updating
-~~~~~~~~
+The generated man pages will be in `docs/man/`.
-::
+To build the documentation diagrams::
- cd simple-bw-scanner
- git pull
- # Determine the newest released version. Assuming it is v1.5.3 ...
- git checkout v1.5.3
+ cd docs/ && make umlsvg
-.. todo::
+The generated diagrams will be in `docs/build/images/`.
This doesn't update dependencies and needs to be fixed.
[View Less]