METADATA 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. Metadata-Version: 2.3
  2. Name: Twisted
  3. Version: 24.11.0
  4. Summary: An asynchronous networking framework written in Python
  5. Project-URL: Changelog, https://github.com/twisted/twisted/blob/HEAD/NEWS.rst
  6. Project-URL: Documentation, https://docs.twisted.org/
  7. Project-URL: Homepage, https://twisted.org/
  8. Project-URL: Issues, https://github.com/twisted/twisted/issues
  9. Project-URL: Source, https://github.com/twisted/twisted
  10. Project-URL: Funding-PSF, https://psfmember.org/civicrm/contribute/transact/?reset=1&id=44
  11. Project-URL: Funding-GitHub, https://github.com/sponsors/twisted
  12. Author-email: Twisted Matrix Community <twisted@python.org>
  13. License: MIT License
  14. Classifier: Programming Language :: Python :: 3
  15. Classifier: Programming Language :: Python :: 3 :: Only
  16. Classifier: Programming Language :: Python :: 3.8
  17. Classifier: Programming Language :: Python :: 3.9
  18. Classifier: Programming Language :: Python :: 3.10
  19. Classifier: Programming Language :: Python :: 3.11
  20. Classifier: Programming Language :: Python :: 3.12
  21. Classifier: Programming Language :: Python :: 3.13
  22. Requires-Python: >=3.8.0
  23. Requires-Dist: attrs>=22.2.0
  24. Requires-Dist: automat>=24.8.0
  25. Requires-Dist: constantly>=15.1
  26. Requires-Dist: hyperlink>=17.1.1
  27. Requires-Dist: incremental>=24.7.0
  28. Requires-Dist: typing-extensions>=4.2.0
  29. Requires-Dist: zope-interface>=5
  30. Provides-Extra: all-non-platform
  31. Requires-Dist: appdirs>=1.4.0; extra == 'all-non-platform'
  32. Requires-Dist: bcrypt>=3.1.3; extra == 'all-non-platform'
  33. Requires-Dist: cryptography>=3.3; extra == 'all-non-platform'
  34. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'all-non-platform'
  35. Requires-Dist: h2<5.0,>=3.2; extra == 'all-non-platform'
  36. Requires-Dist: httpx[http2]>=0.27; extra == 'all-non-platform'
  37. Requires-Dist: hypothesis>=6.56; extra == 'all-non-platform'
  38. Requires-Dist: idna>=2.4; extra == 'all-non-platform'
  39. Requires-Dist: priority<2.0,>=1.1.0; extra == 'all-non-platform'
  40. Requires-Dist: pyhamcrest>=2; extra == 'all-non-platform'
  41. Requires-Dist: pyopenssl>=21.0.0; extra == 'all-non-platform'
  42. Requires-Dist: pyserial>=3.0; extra == 'all-non-platform'
  43. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'all-non-platform'
  44. Requires-Dist: service-identity>=18.1.0; extra == 'all-non-platform'
  45. Provides-Extra: all_non_platform
  46. Requires-Dist: appdirs>=1.4.0; extra == 'all_non_platform'
  47. Requires-Dist: bcrypt>=3.1.3; extra == 'all_non_platform'
  48. Requires-Dist: cryptography>=3.3; extra == 'all_non_platform'
  49. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'all_non_platform'
  50. Requires-Dist: h2<5.0,>=3.2; extra == 'all_non_platform'
  51. Requires-Dist: httpx[http2]>=0.27; extra == 'all_non_platform'
  52. Requires-Dist: hypothesis>=6.56; extra == 'all_non_platform'
  53. Requires-Dist: idna>=2.4; extra == 'all_non_platform'
  54. Requires-Dist: priority<2.0,>=1.1.0; extra == 'all_non_platform'
  55. Requires-Dist: pyhamcrest>=2; extra == 'all_non_platform'
  56. Requires-Dist: pyopenssl>=21.0.0; extra == 'all_non_platform'
  57. Requires-Dist: pyserial>=3.0; extra == 'all_non_platform'
  58. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'all_non_platform'
  59. Requires-Dist: service-identity>=18.1.0; extra == 'all_non_platform'
  60. Provides-Extra: conch
  61. Requires-Dist: appdirs>=1.4.0; extra == 'conch'
  62. Requires-Dist: bcrypt>=3.1.3; extra == 'conch'
  63. Requires-Dist: cryptography>=3.3; extra == 'conch'
  64. Provides-Extra: dev
  65. Requires-Dist: coverage~=7.5; extra == 'dev'
  66. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'dev'
  67. Requires-Dist: httpx[http2]>=0.27; extra == 'dev'
  68. Requires-Dist: hypothesis>=6.56; extra == 'dev'
  69. Requires-Dist: pydoctor~=23.9.0; extra == 'dev'
  70. Requires-Dist: pyflakes~=2.2; extra == 'dev'
  71. Requires-Dist: pyhamcrest>=2; extra == 'dev'
  72. Requires-Dist: python-subunit~=1.4; extra == 'dev'
  73. Requires-Dist: sphinx-rtd-theme~=1.3; extra == 'dev'
  74. Requires-Dist: sphinx<7,>=6; extra == 'dev'
  75. Requires-Dist: towncrier~=23.6; extra == 'dev'
  76. Requires-Dist: twistedchecker~=0.7; extra == 'dev'
  77. Provides-Extra: dev-release
  78. Requires-Dist: pydoctor~=23.9.0; extra == 'dev-release'
  79. Requires-Dist: sphinx-rtd-theme~=1.3; extra == 'dev-release'
  80. Requires-Dist: sphinx<7,>=6; extra == 'dev-release'
  81. Requires-Dist: towncrier~=23.6; extra == 'dev-release'
  82. Provides-Extra: dev_release
  83. Requires-Dist: pydoctor~=23.9.0; extra == 'dev_release'
  84. Requires-Dist: sphinx-rtd-theme~=1.3; extra == 'dev_release'
  85. Requires-Dist: sphinx<7,>=6; extra == 'dev_release'
  86. Requires-Dist: towncrier~=23.6; extra == 'dev_release'
  87. Provides-Extra: gtk-platform
  88. Requires-Dist: appdirs>=1.4.0; extra == 'gtk-platform'
  89. Requires-Dist: bcrypt>=3.1.3; extra == 'gtk-platform'
  90. Requires-Dist: cryptography>=3.3; extra == 'gtk-platform'
  91. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'gtk-platform'
  92. Requires-Dist: h2<5.0,>=3.2; extra == 'gtk-platform'
  93. Requires-Dist: httpx[http2]>=0.27; extra == 'gtk-platform'
  94. Requires-Dist: hypothesis>=6.56; extra == 'gtk-platform'
  95. Requires-Dist: idna>=2.4; extra == 'gtk-platform'
  96. Requires-Dist: priority<2.0,>=1.1.0; extra == 'gtk-platform'
  97. Requires-Dist: pygobject; extra == 'gtk-platform'
  98. Requires-Dist: pyhamcrest>=2; extra == 'gtk-platform'
  99. Requires-Dist: pyopenssl>=21.0.0; extra == 'gtk-platform'
  100. Requires-Dist: pyserial>=3.0; extra == 'gtk-platform'
  101. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'gtk-platform'
  102. Requires-Dist: service-identity>=18.1.0; extra == 'gtk-platform'
  103. Provides-Extra: gtk_platform
  104. Requires-Dist: appdirs>=1.4.0; extra == 'gtk_platform'
  105. Requires-Dist: bcrypt>=3.1.3; extra == 'gtk_platform'
  106. Requires-Dist: cryptography>=3.3; extra == 'gtk_platform'
  107. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'gtk_platform'
  108. Requires-Dist: h2<5.0,>=3.2; extra == 'gtk_platform'
  109. Requires-Dist: httpx[http2]>=0.27; extra == 'gtk_platform'
  110. Requires-Dist: hypothesis>=6.56; extra == 'gtk_platform'
  111. Requires-Dist: idna>=2.4; extra == 'gtk_platform'
  112. Requires-Dist: priority<2.0,>=1.1.0; extra == 'gtk_platform'
  113. Requires-Dist: pygobject; extra == 'gtk_platform'
  114. Requires-Dist: pyhamcrest>=2; extra == 'gtk_platform'
  115. Requires-Dist: pyopenssl>=21.0.0; extra == 'gtk_platform'
  116. Requires-Dist: pyserial>=3.0; extra == 'gtk_platform'
  117. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'gtk_platform'
  118. Requires-Dist: service-identity>=18.1.0; extra == 'gtk_platform'
  119. Provides-Extra: http2
  120. Requires-Dist: h2<5.0,>=3.2; extra == 'http2'
  121. Requires-Dist: priority<2.0,>=1.1.0; extra == 'http2'
  122. Provides-Extra: macos-platform
  123. Requires-Dist: appdirs>=1.4.0; extra == 'macos-platform'
  124. Requires-Dist: bcrypt>=3.1.3; extra == 'macos-platform'
  125. Requires-Dist: cryptography>=3.3; extra == 'macos-platform'
  126. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'macos-platform'
  127. Requires-Dist: h2<5.0,>=3.2; extra == 'macos-platform'
  128. Requires-Dist: httpx[http2]>=0.27; extra == 'macos-platform'
  129. Requires-Dist: hypothesis>=6.56; extra == 'macos-platform'
  130. Requires-Dist: idna>=2.4; extra == 'macos-platform'
  131. Requires-Dist: priority<2.0,>=1.1.0; extra == 'macos-platform'
  132. Requires-Dist: pyhamcrest>=2; extra == 'macos-platform'
  133. Requires-Dist: pyobjc-core; extra == 'macos-platform'
  134. Requires-Dist: pyobjc-framework-cfnetwork; extra == 'macos-platform'
  135. Requires-Dist: pyobjc-framework-cocoa; extra == 'macos-platform'
  136. Requires-Dist: pyopenssl>=21.0.0; extra == 'macos-platform'
  137. Requires-Dist: pyserial>=3.0; extra == 'macos-platform'
  138. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'macos-platform'
  139. Requires-Dist: service-identity>=18.1.0; extra == 'macos-platform'
  140. Provides-Extra: macos_platform
  141. Requires-Dist: appdirs>=1.4.0; extra == 'macos_platform'
  142. Requires-Dist: bcrypt>=3.1.3; extra == 'macos_platform'
  143. Requires-Dist: cryptography>=3.3; extra == 'macos_platform'
  144. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'macos_platform'
  145. Requires-Dist: h2<5.0,>=3.2; extra == 'macos_platform'
  146. Requires-Dist: httpx[http2]>=0.27; extra == 'macos_platform'
  147. Requires-Dist: hypothesis>=6.56; extra == 'macos_platform'
  148. Requires-Dist: idna>=2.4; extra == 'macos_platform'
  149. Requires-Dist: priority<2.0,>=1.1.0; extra == 'macos_platform'
  150. Requires-Dist: pyhamcrest>=2; extra == 'macos_platform'
  151. Requires-Dist: pyobjc-core; extra == 'macos_platform'
  152. Requires-Dist: pyobjc-framework-cfnetwork; extra == 'macos_platform'
  153. Requires-Dist: pyobjc-framework-cocoa; extra == 'macos_platform'
  154. Requires-Dist: pyopenssl>=21.0.0; extra == 'macos_platform'
  155. Requires-Dist: pyserial>=3.0; extra == 'macos_platform'
  156. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'macos_platform'
  157. Requires-Dist: service-identity>=18.1.0; extra == 'macos_platform'
  158. Provides-Extra: mypy
  159. Requires-Dist: appdirs>=1.4.0; extra == 'mypy'
  160. Requires-Dist: bcrypt>=3.1.3; extra == 'mypy'
  161. Requires-Dist: coverage~=7.5; extra == 'mypy'
  162. Requires-Dist: cryptography>=3.3; extra == 'mypy'
  163. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'mypy'
  164. Requires-Dist: h2<5.0,>=3.2; extra == 'mypy'
  165. Requires-Dist: httpx[http2]>=0.27; extra == 'mypy'
  166. Requires-Dist: hypothesis>=6.56; extra == 'mypy'
  167. Requires-Dist: idna>=2.4; extra == 'mypy'
  168. Requires-Dist: mypy-zope==1.0.6; extra == 'mypy'
  169. Requires-Dist: mypy==1.10.1; extra == 'mypy'
  170. Requires-Dist: priority<2.0,>=1.1.0; extra == 'mypy'
  171. Requires-Dist: pydoctor~=23.9.0; extra == 'mypy'
  172. Requires-Dist: pyflakes~=2.2; extra == 'mypy'
  173. Requires-Dist: pyhamcrest>=2; extra == 'mypy'
  174. Requires-Dist: pyopenssl>=21.0.0; extra == 'mypy'
  175. Requires-Dist: pyserial>=3.0; extra == 'mypy'
  176. Requires-Dist: python-subunit~=1.4; extra == 'mypy'
  177. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'mypy'
  178. Requires-Dist: service-identity>=18.1.0; extra == 'mypy'
  179. Requires-Dist: sphinx-rtd-theme~=1.3; extra == 'mypy'
  180. Requires-Dist: sphinx<7,>=6; extra == 'mypy'
  181. Requires-Dist: towncrier~=23.6; extra == 'mypy'
  182. Requires-Dist: twistedchecker~=0.7; extra == 'mypy'
  183. Requires-Dist: types-pyopenssl; extra == 'mypy'
  184. Requires-Dist: types-setuptools; extra == 'mypy'
  185. Provides-Extra: osx-platform
  186. Requires-Dist: appdirs>=1.4.0; extra == 'osx-platform'
  187. Requires-Dist: bcrypt>=3.1.3; extra == 'osx-platform'
  188. Requires-Dist: cryptography>=3.3; extra == 'osx-platform'
  189. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'osx-platform'
  190. Requires-Dist: h2<5.0,>=3.2; extra == 'osx-platform'
  191. Requires-Dist: httpx[http2]>=0.27; extra == 'osx-platform'
  192. Requires-Dist: hypothesis>=6.56; extra == 'osx-platform'
  193. Requires-Dist: idna>=2.4; extra == 'osx-platform'
  194. Requires-Dist: priority<2.0,>=1.1.0; extra == 'osx-platform'
  195. Requires-Dist: pyhamcrest>=2; extra == 'osx-platform'
  196. Requires-Dist: pyobjc-core; extra == 'osx-platform'
  197. Requires-Dist: pyobjc-framework-cfnetwork; extra == 'osx-platform'
  198. Requires-Dist: pyobjc-framework-cocoa; extra == 'osx-platform'
  199. Requires-Dist: pyopenssl>=21.0.0; extra == 'osx-platform'
  200. Requires-Dist: pyserial>=3.0; extra == 'osx-platform'
  201. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'osx-platform'
  202. Requires-Dist: service-identity>=18.1.0; extra == 'osx-platform'
  203. Provides-Extra: osx_platform
  204. Requires-Dist: appdirs>=1.4.0; extra == 'osx_platform'
  205. Requires-Dist: bcrypt>=3.1.3; extra == 'osx_platform'
  206. Requires-Dist: cryptography>=3.3; extra == 'osx_platform'
  207. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'osx_platform'
  208. Requires-Dist: h2<5.0,>=3.2; extra == 'osx_platform'
  209. Requires-Dist: httpx[http2]>=0.27; extra == 'osx_platform'
  210. Requires-Dist: hypothesis>=6.56; extra == 'osx_platform'
  211. Requires-Dist: idna>=2.4; extra == 'osx_platform'
  212. Requires-Dist: priority<2.0,>=1.1.0; extra == 'osx_platform'
  213. Requires-Dist: pyhamcrest>=2; extra == 'osx_platform'
  214. Requires-Dist: pyobjc-core; extra == 'osx_platform'
  215. Requires-Dist: pyobjc-framework-cfnetwork; extra == 'osx_platform'
  216. Requires-Dist: pyobjc-framework-cocoa; extra == 'osx_platform'
  217. Requires-Dist: pyopenssl>=21.0.0; extra == 'osx_platform'
  218. Requires-Dist: pyserial>=3.0; extra == 'osx_platform'
  219. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'osx_platform'
  220. Requires-Dist: service-identity>=18.1.0; extra == 'osx_platform'
  221. Provides-Extra: serial
  222. Requires-Dist: pyserial>=3.0; extra == 'serial'
  223. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'serial'
  224. Provides-Extra: test
  225. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'test'
  226. Requires-Dist: httpx[http2]>=0.27; extra == 'test'
  227. Requires-Dist: hypothesis>=6.56; extra == 'test'
  228. Requires-Dist: pyhamcrest>=2; extra == 'test'
  229. Provides-Extra: tls
  230. Requires-Dist: idna>=2.4; extra == 'tls'
  231. Requires-Dist: pyopenssl>=21.0.0; extra == 'tls'
  232. Requires-Dist: service-identity>=18.1.0; extra == 'tls'
  233. Provides-Extra: windows-platform
  234. Requires-Dist: appdirs>=1.4.0; extra == 'windows-platform'
  235. Requires-Dist: bcrypt>=3.1.3; extra == 'windows-platform'
  236. Requires-Dist: cryptography>=3.3; extra == 'windows-platform'
  237. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'windows-platform'
  238. Requires-Dist: h2<5.0,>=3.2; extra == 'windows-platform'
  239. Requires-Dist: httpx[http2]>=0.27; extra == 'windows-platform'
  240. Requires-Dist: hypothesis>=6.56; extra == 'windows-platform'
  241. Requires-Dist: idna>=2.4; extra == 'windows-platform'
  242. Requires-Dist: priority<2.0,>=1.1.0; extra == 'windows-platform'
  243. Requires-Dist: pyhamcrest>=2; extra == 'windows-platform'
  244. Requires-Dist: pyopenssl>=21.0.0; extra == 'windows-platform'
  245. Requires-Dist: pyserial>=3.0; extra == 'windows-platform'
  246. Requires-Dist: pywin32!=226; extra == 'windows-platform'
  247. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'windows-platform'
  248. Requires-Dist: service-identity>=18.1.0; extra == 'windows-platform'
  249. Requires-Dist: twisted-iocpsupport>=1.0.2; extra == 'windows-platform'
  250. Provides-Extra: windows_platform
  251. Requires-Dist: appdirs>=1.4.0; extra == 'windows_platform'
  252. Requires-Dist: bcrypt>=3.1.3; extra == 'windows_platform'
  253. Requires-Dist: cryptography>=3.3; extra == 'windows_platform'
  254. Requires-Dist: cython-test-exception-raiser<2,>=1.0.2; extra == 'windows_platform'
  255. Requires-Dist: h2<5.0,>=3.2; extra == 'windows_platform'
  256. Requires-Dist: httpx[http2]>=0.27; extra == 'windows_platform'
  257. Requires-Dist: hypothesis>=6.56; extra == 'windows_platform'
  258. Requires-Dist: idna>=2.4; extra == 'windows_platform'
  259. Requires-Dist: priority<2.0,>=1.1.0; extra == 'windows_platform'
  260. Requires-Dist: pyhamcrest>=2; extra == 'windows_platform'
  261. Requires-Dist: pyopenssl>=21.0.0; extra == 'windows_platform'
  262. Requires-Dist: pyserial>=3.0; extra == 'windows_platform'
  263. Requires-Dist: pywin32!=226; extra == 'windows_platform'
  264. Requires-Dist: pywin32!=226; (platform_system == 'Windows') and extra == 'windows_platform'
  265. Requires-Dist: service-identity>=18.1.0; extra == 'windows_platform'
  266. Requires-Dist: twisted-iocpsupport>=1.0.2; extra == 'windows_platform'
  267. Description-Content-Type: text/x-rst
  268. Twisted
  269. #######
  270. |gitter|_
  271. |rtd|_
  272. |pypi|_
  273. |ci|_
  274. For information on changes in this release, see the `NEWS <https://github.com/twisted/twisted/blob/trunk/NEWS.rst>`_ file.
  275. Sponsors
  276. --------
  277. Twisted is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and these awesome sponsors.
  278. If you'd like to join them, please consider `sponsoring Twisted's <https://docs.twisted.org/en/latest/development/sponsorship.html>`_ development.
  279. |thinkst|_
  280. |sftpplus|_
  281. What is this?
  282. -------------
  283. Twisted is a Python event-based framework for internet applications.
  284. It includes modules for many different purposes, including the following:
  285. - ``twisted.web``: HTTP clients and servers, HTML templating, and a WSGI server
  286. - ``twisted.conch``: SSHv2 and Telnet clients and servers and terminal emulators
  287. - ``twisted.words``: Clients and servers for IRC, XMPP, and other IM protocols
  288. - ``twisted.mail``: IMAPv4, POP3, SMTP clients and servers
  289. - ``twisted.positioning``: Tools for communicating with NMEA-compatible GPS receivers
  290. - ``twisted.names``: DNS client and tools for making your own DNS servers
  291. - ``twisted.trial``: A unit testing framework that integrates well with Twisted-based code.
  292. Twisted supports all major system event loops -- ``select`` (all platforms), ``poll`` (most POSIX platforms), ``epoll`` (Linux), ``kqueue`` (FreeBSD, macOS), IOCP (Windows), and various GUI event loops (GTK+2/3, Qt, wxWidgets).
  293. Third-party reactors can plug into Twisted, and provide support for additional event loops.
  294. Installing
  295. ----------
  296. To install the latest version of Twisted using pip::
  297. $ pip install twisted
  298. Additional instructions for installing this software are in `the installation instructions <https://docs.twisted.org/en/latest/installation.html>`_.
  299. Documentation and Support
  300. -------------------------
  301. Twisted's documentation is available from the `Twisted Matrix Read The Docs website <https://docs.twisted.org/>`_.
  302. This documentation contains how-tos, code examples, and an API reference.
  303. Help is also available on the `Twisted mailing list <https://mail.python.org/mailman3/lists/twisted.python.org/>`_.
  304. There is also an IRC channel, ``#twisted``,
  305. on the `Libera.Chat <https://libera.chat/>`_ network.
  306. A web client is available at `web.libera.chat <https://web.libera.chat/>`_.
  307. Unit Tests
  308. ----------
  309. Twisted has a comprehensive test suite, which can be run by ``tox``::
  310. $ tox -l # to view all test environments
  311. $ tox -e nocov # to run all the tests without coverage
  312. $ tox -e withcov # to run all the tests with coverage
  313. $ tox -e alldeps-withcov-posix # install all dependencies, run tests with coverage on POSIX platform
  314. You can test running the test suite under the different reactors with the ``TWISTED_REACTOR`` environment variable::
  315. $ env TWISTED_REACTOR=epoll tox -e alldeps-withcov-posix
  316. Some of these tests may fail if you:
  317. * don't have the dependencies required for a particular subsystem installed,
  318. * have a firewall blocking some ports (or things like Multicast, which Linux NAT has shown itself to do), or
  319. * run them as root.
  320. Static Code Checkers
  321. --------------------
  322. You can ensure that code complies to Twisted `coding standards <https://docs.twisted.org/en/latest/development/coding-standard.html>`_::
  323. $ tox -e lint # run pre-commit to check coding stanards
  324. $ tox -e mypy # run MyPy static type checker to check for type errors
  325. Or, for speed, use pre-commit directly::
  326. $ pipx run pre-commit run
  327. Copyright
  328. ---------
  329. All of the code in this distribution is Copyright (c) 2001-2024 Twisted Matrix Laboratories.
  330. Twisted is made available under the MIT license.
  331. The included `LICENSE <https://github.com/twisted/twisted/blob/trunk/LICENSE>`_ file describes this in detail.
  332. Warranty
  333. --------
  334. THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  335. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  336. OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
  337. TO THE USE OF THIS SOFTWARE IS WITH YOU.
  338. IN NO EVENT WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
  339. AND/OR REDISTRIBUTE THE LIBRARY, BE LIABLE TO YOU FOR ANY DAMAGES, EVEN IF
  340. SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  341. DAMAGES.
  342. Again, see the included `LICENSE <https://github.com/twisted/twisted/blob/trunk/LICENSE>`_ file for specific legal details.
  343. .. |pypi| image:: https://img.shields.io/pypi/v/twisted.svg
  344. .. _pypi: https://pypi.python.org/pypi/twisted
  345. .. |gitter| image:: https://img.shields.io/gitter/room/twisted/twisted.svg
  346. .. _gitter: https://gitter.im/twisted/twisted
  347. .. |ci| image:: https://github.com/twisted/twisted/actions/workflows/test.yaml/badge.svg
  348. .. _ci: https://github.com/twisted/twisted
  349. .. |rtd| image:: https://readthedocs.org/projects/twisted/badge/?version=latest&style=flat
  350. .. _rtd: https://docs.twistedmatrix.com
  351. .. |thinkst| image:: https://github.com/user-attachments/assets/a5b52432-2d18-4d91-a3c9-772fb2e02781
  352. :alt: Thinkst Canary
  353. .. _thinkst: https://thinkst.com/
  354. .. |sftpplus| image:: https://github.com/user-attachments/assets/5f585316-c7e8-4ef1-8fbb-923f0756ceed
  355. :alt: SFTPPlus
  356. .. _sftpplus: https://www.sftpplus.com/