diff options
author | shmel1k <shmel1k@ydb.tech> | 2023-11-26 18:16:14 +0300 |
---|---|---|
committer | shmel1k <shmel1k@ydb.tech> | 2023-11-26 18:43:30 +0300 |
commit | b8cf9e88f4c5c64d9406af533d8948deb050d695 (patch) | |
tree | 218eb61fb3c3b96ec08b4d8cdfef383104a87d63 /contrib/python/Twisted/py2/README.rst | |
parent | 523f645a83a0ec97a0332dbc3863bb354c92a328 (diff) | |
download | ydb-b8cf9e88f4c5c64d9406af533d8948deb050d695.tar.gz |
add kikimr_configure
Diffstat (limited to 'contrib/python/Twisted/py2/README.rst')
-rw-r--r-- | contrib/python/Twisted/py2/README.rst | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/contrib/python/Twisted/py2/README.rst b/contrib/python/Twisted/py2/README.rst new file mode 100644 index 0000000000..d28319f33d --- /dev/null +++ b/contrib/python/Twisted/py2/README.rst @@ -0,0 +1,104 @@ +Twisted +======= + +|pypi|_ +|travis|_ +|circleci|_ + +For information on changes in this release, see the `NEWS <NEWS.rst>`_ file. + + +What is this? +------------- + +Twisted is an event-based framework for internet applications, supporting Python 2.7 and Python 3.5+. +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 <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://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python>`_. + +There is also a pair of very lively IRC channels, ``#twisted`` (for general Twisted questions) and ``#twisted.web`` (for Twisted Web), on ``chat.freenode.net``. + + +Unit Tests +---------- + +Twisted has a comprehensive test suite, which can be run by ``tox``:: + + $ tox -l # to view all test environments + $ tox -e py27-tests # to run the tests for Python 2.7 + $ tox -e py35-tests # to run the tests for Python 3.5 + + +You can test running the test suite under the different reactors with the ``TWISTED_REACTOR`` environment variable:: + + $ env TWISTED_REACTOR=epoll tox -e py27-tests + + +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. + + +Copyright +--------- + +All of the code in this distribution is Copyright (c) 2001-2020 Twisted Matrix Laboratories. + +Twisted is made available under the MIT license. +The included `LICENSE <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 <LICENSE>`_ file for specific legal details. + + +.. |pypi| image:: http://img.shields.io/pypi/v/twisted.svg +.. _pypi: https://pypi.python.org/pypi/twisted + +.. |travis| image:: https://travis-ci.org/twisted/twisted.svg?branch=trunk +.. _travis: https://travis-ci.org/twisted/twisted + +.. |circleci| image:: https://circleci.com/gh/twisted/twisted.svg?style=svg +.. _circleci: https://circleci.com/gh/twisted/twisted |