Ravenports generated: 10 Feb 2024 22:55
[ravenports.git] / bucket_EC / python-Twisted
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-Twisted
4 VERSION=                23.10.0
5 KEYWORDS=               python
6 VARIANTS=               v11 v12
7 SDESC[v11]=             Asynchronous networking framework (3.11)
8 SDESC[v12]=             Asynchronous networking framework (3.12)
9 HOMEPAGE=               https://twistedmatrix.com/
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/24/83/8d34d264c72d5450cd3d3ef31c885bb36b94635aa8e9e223581793d9d6c8
14 DISTFILE[1]=            twisted-23.10.0-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[v11]=             single
17 SPKGS[v12]=             single
18
19 OPTIONS_AVAILABLE=      PY311 PY312
20 OPTIONS_STANDARD=       none
21 VOPTS[v11]=             PY311=ON PY312=OFF
22 VOPTS[v12]=             PY311=OFF PY312=ON
23
24 USES=                   cpe
25
26 DISTNAME=               twisted-23.10.0.dist-info
27
28 CPE_PRODUCT=            twisted
29 CPE_VENDOR=             twistedmatrix
30 GENERATED=              yes
31
32 [PY311].RUN_DEPENDS_ON=                 python-attrs:single:v11
33                                         python-Automat:single:v11
34                                         python-constantly:single:v11
35                                         python-hyperlink:single:v11
36                                         python-incremental:single:v11
37                                         python-typing-extensions:single:v11
38                                         python-zope.interface:single:v11
39 [PY311].USES_ON=                        python:v11,wheel
40
41 [PY312].RUN_DEPENDS_ON=                 python-attrs:single:v12
42                                         python-Automat:single:v12
43                                         python-constantly:single:v12
44                                         python-hyperlink:single:v12
45                                         python-incremental:single:v12
46                                         python-typing-extensions:single:v12
47                                         python-zope.interface:single:v12
48 [PY312].USES_ON=                        python:v12,wheel
49
50 [FILE:3041:descriptions/desc.single]
51 Twisted
52 #######
53
54 |gitter|_
55 |rtd|_
56 |pypi|_
57 |ci|_
58
59 For information on changes in this release, see the [NEWS] file.
60
61 What is this?
62 -------------
63
64 Twisted is an event-based framework for internet applications, supporting
65 Python 3.6+.
66 It includes modules for many different purposes, including the following:
67
68 - ``twisted.web``: HTTP clients and servers, HTML templating, and a WSGI
69 server
70 - ``twisted.conch``: SSHv2 and Telnet clients and servers and terminal
71 emulators
72 - ``twisted.words``: Clients and servers for IRC, XMPP, and other IM
73 protocols
74 - ``twisted.mail``: IMAPv4, POP3, SMTP clients and servers
75 - ``twisted.positioning``: Tools for communicating with NMEA-compatible GPS
76 receivers
77 - ``twisted.names``: DNS client and tools for making your own DNS servers
78 - ``twisted.trial``: A unit testing framework that integrates well with
79 Twisted-based code.
80
81 Twisted supports all major system event loops -- select (all platforms),
82 poll (most POSIX platforms), epoll (Linux), kqueue (FreeBSD, macOS), IOCP
83 (Windows), and various GUI event loops (GTK+2/3, Qt, wxWidgets).
84 Third-party reactors can plug into Twisted, and provide support for
85 additional event loops.
86
87 Installing
88 ----------
89
90 To install the latest version of Twisted using pip::
91
92   $ pip install twisted
93
94 Additional instructions for installing this software are in [the
95 installation instructions].
96
97 Documentation and Support
98 -------------------------
99
100 Twisted's documentation is available from the [Twisted Matrix website].
101 This documentation contains how-tos, code examples, and an API reference.
102
103 Help is also available on the [Twisted mailing list].
104
105 There is also an IRC channel, ``#twisted``,
106 on the `Libera.Chat <https://libera.chat/>`_ network.
107 A web client is available at `web.libera.chat <https://web.libera.chat/>`_.
108
109 Unit Tests
110 ----------
111
112 Twisted has a comprehensive test suite, which can be run by tox::
113
114   $ tox -l                       # to view all test environments
115   $ tox -e nocov                 # to run all the tests without coverage
116   $ tox -e withcov               # to run all the tests with coverage
117   $ tox -e alldeps-withcov-posix # install all dependencies, run tests with
118 coverage on POSIX platform
119
120 You can test running the test suite under the different reactors with the
121 TWISTED_REACTOR environment variable::
122
123   $ env TWISTED_REACTOR=epoll tox -e alldeps-withcov-posix
124
125 Some of these tests may fail if you:
126
127 * don't have the dependencies required for a particular subsystem
128 installed,
129 * have a firewall blocking some ports (or things like Multicast, which
130 Linux NAT has shown itself to do), or
131 * run them as root.
132
133 Static Code Checkers
134 --------------------
135
136 You can ensure that code complies to Twisted [coding standards]::
137
138   $ tox -e lint   # run pre-commit to check coding stanards
139   $ tox -e mypy   # run MyPy static type checker to check for type errors
140
141 Or, for speed, use pre-commit directly::
142
143   $ pipx run pre-commit run
144
145 Copyright
146 ---------
147
148 All of the code in this distribution is Copyright (c) 2001-2023 Twisted
149 Matrix Laboratories.
150
151
152
153 [FILE:111:distinfo]
154 4ae8bce12999a35f7fe6443e7f1893e6fe09588c8d2bed9c35cdce8ff2d5b444      3162487 twisted-23.10.0-py3-none-any.whl
155