[Pkg-privacy-commits] [txtorcon] 19/96: More dev deps, nicer coverage report and doc tweaks

[Jérémy Bobbio]

This is an automated email from the git hooks/post-receive script.

lunar pushed a commit to branch master
in repository txtorcon.

commit e36831e0a5d4faa7e80184ed31dba2273effd6ec
Author: meejah <meejah at meejah.ca>
Date:   Sat Jan 17 00:24:06 2015 -0700

    More dev deps, nicer coverage report and doc tweaks
---
 Makefile             |  2 +-
 dev-requirements.txt |  3 +++
 docs/index.rst       | 11 +++++++----
 3 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/Makefile b/Makefile
index 4c99f59..eef4479 100644
--- a/Makefile
+++ b/Makefile
@@ -36,7 +36,7 @@ doc: docs/*.rst
 coverage:
 	coverage run --source=txtorcon `which trial` test
 	coverage -a -d annotated_coverage
-	coverage report
+	coverage report --show-missing
 
 # dang, this is a little annoying. maybe add a shell-script which
 # looks for "coverage" or "python-coverage"??
diff --git a/dev-requirements.txt b/dev-requirements.txt
index cab9e2d..8ea4bab 100644
--- a/dev-requirements.txt
+++ b/dev-requirements.txt
@@ -7,3 +7,6 @@ twine
 pyflakes
 pep8
 mock
+# these are optional for users, but for testing we need them
+ipaddr
+GeoIP
diff --git a/docs/index.rst b/docs/index.rst
index d4862c6..c6c0c19 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,16 +9,19 @@ txtorcon is a `Twisted <https://twistedmatrix.com/>`_-based `Python
 <https://www.torproject.org/>`_, following `control-spec
 <https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt>`_.
 This would be of interest to anyone wishing to write event-based
-software in Python that talks to a Tor program.
+software in Python that talks to (and/or launches) a Tor program.
+
+You get real-time access to all state in Tor (circuits, streams,
+logging, hidden-services) and utilities to launch or connect to running
+Tor instances (including Tor Browser Bundle).
 
 There is a `Walkthrough <walkthrough.html>`_ and `HOWTOs <howtos.html>`_.
 
 The main code is around 2300 lines according to ohcount, or about 5600
-lines including tests. With **full endpoint support, any endpoint-aware
-Twisted application can easily use an automatically-launched Tor**.
+lines including tests.
 
 With txtorcon installed, you can use ``"onion:"`` port/endpoint
-strings with any endpoint-aware Twisted program. For example, to use
+strings with **any endpoint-aware Twisted program**. For example, to use
 Twisted Web to serve your ``~/public_html`` as a hidden service
 (``-n`` *means don't daemonize and log to stdout*):
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/txtorcon.git