| Name | Twisted JSON |
| Version |
24.3.0
JSON |
| download |
| home_page | |
| Summary | An asynchronous networking framework written in Python |
| upload_time | 2024-03-01 16:44:28 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8.0 |
| license | MIT License |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
Twisted
#######
|gitter|_
|rtd|_
|pypi|_
|ci|_
For information on changes in this release, see the `NEWS <https://github.com/twisted/twisted/blob/trunk/NEWS.rst>`_ file.
What is this?
-------------
Twisted is an event-based framework for internet applications, supporting Python 3.6+.
It includes modules for many different purposes, including the following:
- ``twisted.web``: HTTP clients and servers, HTML templating, and a WSGI server
- ``twisted.conch``: SSHv2 and Telnet clients and servers and terminal emulators
- ``twisted.words``: Clients and servers for IRC, XMPP, and other IM protocols
- ``twisted.mail``: IMAPv4, POP3, SMTP clients and servers
- ``twisted.positioning``: Tools for communicating with NMEA-compatible GPS receivers
- ``twisted.names``: DNS client and tools for making your own DNS servers
- ``twisted.trial``: A unit testing framework that integrates well with Twisted-based code.
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).
Third-party reactors can plug into Twisted, and provide support for additional event loops.
Installing
----------
To install the latest version of Twisted using pip::
$ pip install twisted
Additional instructions for installing this software are in `the installation instructions <https://github.com/twisted/twisted/blob/trunk/INSTALL.rst>`_.
Documentation and Support
-------------------------
Twisted's documentation is available from the `Twisted Matrix website <https://twistedmatrix.com/documents/current/>`_.
This documentation contains how-tos, code examples, and an API reference.
Help is also available on the `Twisted mailing list <https://mail.python.org/mailman3/lists/twisted.python.org/>`_.
There is also an IRC channel, ``#twisted``,
on the `Libera.Chat <https://libera.chat/>`_ network.
A web client is available at `web.libera.chat <https://web.libera.chat/>`_.
Unit Tests
----------
Twisted has a comprehensive test suite, which can be run by ``tox``::
$ tox -l # to view all test environments
$ tox -e nocov # to run all the tests without coverage
$ tox -e withcov # to run all the tests with coverage
$ tox -e alldeps-withcov-posix # install all dependencies, run tests with coverage on POSIX platform
You can test running the test suite under the different reactors with the ``TWISTED_REACTOR`` environment variable::
$ env TWISTED_REACTOR=epoll tox -e alldeps-withcov-posix
Some of these tests may fail if you:
* don't have the dependencies required for a particular subsystem installed,
* have a firewall blocking some ports (or things like Multicast, which Linux NAT has shown itself to do), or
* run them as root.
Static Code Checkers
--------------------
You can ensure that code complies to Twisted `coding standards <https://twistedmatrix.com/documents/current/core/development/policy/coding-standard.html>`_::
$ tox -e lint # run pre-commit to check coding stanards
$ tox -e mypy # run MyPy static type checker to check for type errors
Or, for speed, use pre-commit directly::
$ pipx run pre-commit run
Copyright
---------
All of the code in this distribution is Copyright (c) 2001-2024 Twisted Matrix Laboratories.
Twisted is made available under the MIT license.
The included `LICENSE <https://github.com/twisted/twisted/blob/trunk/LICENSE>`_ file describes this in detail.
Warranty
--------
THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE USE OF THIS SOFTWARE IS WITH YOU.
IN NO EVENT WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY, BE LIABLE TO YOU FOR ANY DAMAGES, EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
Again, see the included `LICENSE <https://github.com/twisted/twisted/blob/trunk/LICENSE>`_ file for specific legal details.
.. |pypi| image:: https://img.shields.io/pypi/v/twisted.svg
.. _pypi: https://pypi.python.org/pypi/twisted
.. |gitter| image:: https://img.shields.io/gitter/room/twisted/twisted.svg
.. _gitter: https://gitter.im/twisted/twisted
.. |ci| image:: https://github.com/twisted/twisted/actions/workflows/test.yaml/badge.svg
.. _ci: https://github.com/twisted/twisted
.. |rtd| image:: https://readthedocs.org/projects/twisted/badge/?version=latest&style=flat
.. _rtd: https://docs.twistedmatrix.com
Raw data
{
"_id": null,
"home_page": "",
"name": "Twisted",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Twisted Matrix Laboratories <twisted-python@twistedmatrix.com>",
"download_url": "https://files.pythonhosted.org/packages/fc/8d/9c09d75173984d3b0f0dcf65d885fe61a06de11db2c30b1196d85f631cfc/twisted-24.3.0.tar.gz",
"platform": null,
"description": "Twisted\n#######\n\n|gitter|_\n|rtd|_\n|pypi|_\n|ci|_\n\nFor information on changes in this release, see the `NEWS <https://github.com/twisted/twisted/blob/trunk/NEWS.rst>`_ file.\n\n\nWhat is this?\n-------------\n\nTwisted is an event-based framework for internet applications, supporting Python 3.6+.\nIt includes modules for many different purposes, including the following:\n\n- ``twisted.web``: HTTP clients and servers, HTML templating, and a WSGI server\n- ``twisted.conch``: SSHv2 and Telnet clients and servers and terminal emulators\n- ``twisted.words``: Clients and servers for IRC, XMPP, and other IM protocols\n- ``twisted.mail``: IMAPv4, POP3, SMTP clients and servers\n- ``twisted.positioning``: Tools for communicating with NMEA-compatible GPS receivers\n- ``twisted.names``: DNS client and tools for making your own DNS servers\n- ``twisted.trial``: A unit testing framework that integrates well with Twisted-based code.\n\nTwisted 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).\nThird-party reactors can plug into Twisted, and provide support for additional event loops.\n\n\nInstalling\n----------\n\nTo install the latest version of Twisted using pip::\n\n $ pip install twisted\n\nAdditional instructions for installing this software are in `the installation instructions <https://github.com/twisted/twisted/blob/trunk/INSTALL.rst>`_.\n\n\nDocumentation and Support\n-------------------------\n\nTwisted's documentation is available from the `Twisted Matrix website <https://twistedmatrix.com/documents/current/>`_.\nThis documentation contains how-tos, code examples, and an API reference.\n\nHelp is also available on the `Twisted mailing list <https://mail.python.org/mailman3/lists/twisted.python.org/>`_.\n\nThere is also an IRC channel, ``#twisted``,\non the `Libera.Chat <https://libera.chat/>`_ network.\nA web client is available at `web.libera.chat <https://web.libera.chat/>`_.\n\n\nUnit Tests\n----------\n\nTwisted has a comprehensive test suite, which can be run by ``tox``::\n\n $ tox -l # to view all test environments\n $ tox -e nocov # to run all the tests without coverage\n $ tox -e withcov # to run all the tests with coverage\n $ tox -e alldeps-withcov-posix # install all dependencies, run tests with coverage on POSIX platform\n\n\nYou can test running the test suite under the different reactors with the ``TWISTED_REACTOR`` environment variable::\n\n $ env TWISTED_REACTOR=epoll tox -e alldeps-withcov-posix\n\nSome of these tests may fail if you:\n\n* don't have the dependencies required for a particular subsystem installed,\n* have a firewall blocking some ports (or things like Multicast, which Linux NAT has shown itself to do), or\n* run them as root.\n\n\nStatic Code Checkers\n--------------------\n\nYou can ensure that code complies to Twisted `coding standards <https://twistedmatrix.com/documents/current/core/development/policy/coding-standard.html>`_::\n\n $ tox -e lint # run pre-commit to check coding stanards\n $ tox -e mypy # run MyPy static type checker to check for type errors\n\nOr, for speed, use pre-commit directly::\n\n $ pipx run pre-commit run\n\n\nCopyright\n---------\n\nAll of the code in this distribution is Copyright (c) 2001-2024 Twisted Matrix Laboratories.\n\nTwisted is made available under the MIT license.\nThe included `LICENSE <https://github.com/twisted/twisted/blob/trunk/LICENSE>`_ file describes this in detail.\n\n\nWarranty\n--------\n\n THIS SOFTWARE IS PROVIDED \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER\n EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\n OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS\n TO THE USE OF THIS SOFTWARE IS WITH YOU.\n\n IN NO EVENT WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY\n AND/OR REDISTRIBUTE THE LIBRARY, BE LIABLE TO YOU FOR ANY DAMAGES, EVEN IF\n SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH\n DAMAGES.\n\nAgain, see the included `LICENSE <https://github.com/twisted/twisted/blob/trunk/LICENSE>`_ file for specific legal details.\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/twisted.svg\n.. _pypi: https://pypi.python.org/pypi/twisted\n\n.. |gitter| image:: https://img.shields.io/gitter/room/twisted/twisted.svg\n.. _gitter: https://gitter.im/twisted/twisted\n\n.. |ci| image:: https://github.com/twisted/twisted/actions/workflows/test.yaml/badge.svg\n.. _ci: https://github.com/twisted/twisted\n\n.. |rtd| image:: https://readthedocs.org/projects/twisted/badge/?version=latest&style=flat\n.. _rtd: https://docs.twistedmatrix.com\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "An asynchronous networking framework written in Python",
"version": "24.3.0",
"project_urls": {
"Changelog": "https://github.com/twisted/twisted/blob/HEAD/NEWS.rst",
"Documentation": "https://docs.twistedmatrix.com/",
"Homepage": "https://twistedmatrix.com/",
"Issues": "https://twistedmatrix.com/trac/report",
"Source": "https://github.com/twisted/twisted",
"Twitter": "https://twitter.com/twistedmatrix"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8f3ff962a66ed957f4b51a669f25f6d0026a51dda1d25e3766a63d9a5aaf81e",
"md5": "6203f4abe8846bf45085a6f774b5da25",
"sha256": "039f2e6a49ab5108abd94de187fa92377abe5985c7a72d68d0ad266ba19eae63"
},
"downloads": -1,
"filename": "twisted-24.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6203f4abe8846bf45085a6f774b5da25",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 3165636,
"upload_time": "2024-03-01T16:44:25",
"upload_time_iso_8601": "2024-03-01T16:44:25.978377Z",
"url": "https://files.pythonhosted.org/packages/f8/f3/ff962a66ed957f4b51a669f25f6d0026a51dda1d25e3766a63d9a5aaf81e/twisted-24.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc8d9c09d75173984d3b0f0dcf65d885fe61a06de11db2c30b1196d85f631cfc",
"md5": "85d7a8d1552151cfd9e42417ab2ff875",
"sha256": "6b38b6ece7296b5e122c9eb17da2eeab3d98a198f50ca9efd00fb03e5b4fd4ae"
},
"downloads": -1,
"filename": "twisted-24.3.0.tar.gz",
"has_sig": false,
"md5_digest": "85d7a8d1552151cfd9e42417ab2ff875",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 3500456,
"upload_time": "2024-03-01T16:44:28",
"upload_time_iso_8601": "2024-03-01T16:44:28.771525Z",
"url": "https://files.pythonhosted.org/packages/fc/8d/9c09d75173984d3b0f0dcf65d885fe61a06de11db2c30b1196d85f631cfc/twisted-24.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 16:44:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "twisted",
"github_project": "twisted",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "twisted"
}
