1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
.. txtorcon documentation master file, created by
sphinx-quickstart on Thu Jan 26 13:04:28 2012.
txtorcon
========
- **docs**:
- v3 onion: http://fjblvrw2jrxnhtg67qpbzi45r7ofojaoo3orzykesly2j3c2m3htapid.onion/
- v2 onion: http://timaq4ygg2iegci7.onion
- clearnet: https://txtorcon.readthedocs.org
- **code**: https://github.com/meejah/txtorcon
- ``torsocks git clone git://timaq4ygg2iegci7.onion/txtorcon.git``
.. container:: first_time
If this is your first time exploring txtorcon, please **look at the**
:ref:`introduction` **first**. These docs are for version |version|.
.. comment::
+---------------+---------+---------+
| Twisted | 15.5.0+ | 16.3.0+ |
+===============+=========+=========+
| Python 2.7+ | ✓ | ✓ |
+---------------+---------+---------+
| Python 3.5+ | ✓ | ✓ |
+---------------+---------+---------+
| PyPy 5.0.0+ | ✓ | ✓ |
+---------------+---------+---------+
Supported and tested platforms: Python 3.5+, PyPy 5.0.0+, Python 2.7+ (deprecated)
using Twisted 15.5.0+, 16.3.0+, or 17.1.0+ (see `travis
<https://travis-ci.org/meejah/txtorcon>`_).
**Asycnio inter-operation** is now possible, see :ref:`interop_asyncio`
Documentation
-------------
.. toctree::
:maxdepth: 3
introduction
installing
guide
examples
interop_asyncio
hacking
Official Releases:
------------------
All official releases are tagged in Git, and signed by my key. All official releases on PyPI have a corresponding GPG signature of the build. Please be aware that ``pip`` does *not* check GPG signatures by default; please see `this ticket <https://github.com/pypa/pip/issues/1035>`_ if you care.
The most reliable way to verify you got what I intended is to clone the Git repository, ``git checkout`` a tag and verify its signature. The second-best would be to download a release + tag from PyPI and verify that.
.. toctree::
:maxdepth: 2
releases
API Documentation
-----------------
These are the lowest-level documents, directly from the doc-strings in
the code with some minimal organization; if you're just getting
started with txtorcon **the** ":ref:`programming_guide`" **is a better
place to start**.
.. toctree::
:maxdepth: 3
txtorcon
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|