Event-driven networking engine written in Python.
  • Python 99.3%
  • Cython 0.2%
  • C 0.2%
  • GAP 0.1%
  • Roff 0.1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Tom Most 672edec1a9
Merge pull request #1052 from twisted/9514-logpredicate-docs
Author: twm
Reviewer: glyph
Fixes: ticket:9514

Fix PredicateResult docstrings
2018-09-12 23:35:11 -07:00
.circleci don't run this on circle 2018-07-25 17:01:06 +10:00
.github Initial code for external pycodestyle checker. 2018-03-17 15:13:32 +00:00
.travis Update the format produced by twistedchecker. 2017-09-25 12:12:19 +01:00
admin Update after review. 2018-03-20 14:37:16 +00:00
bin/admin Change topfile to newsfragment 2017-08-03 21:51:07 -07:00
docs Merge remote-tracking branch 'upstream/trunk' into 7927-unhandled-error-tb-3 2018-07-20 22:10:16 -06:00
src/twisted Merge branch 'trunk' into 9514-logpredicate-docs 2018-09-11 23:18:04 -07:00
.coveragerc correct src spot 2016-08-17 20:01:40 +10:00
.gitignore Add automat-visualize output directory to .gitignore. 2016-12-20 22:30:41 -07:00
.travis.yml xenial/sudo to get py3.7 on travis 2018-09-05 22:10:23 -04:00
appveyor.yml correct TOXENV for py37 AppVeyor jobs 2018-09-05 22:44:55 -04:00
code_of_conduct.md Merge explicit-is-better-than-implicit-8173: Adopt a Code of Conduct 2016-01-21 04:04:01 +00:00
codecov.yml Update comment. 2016-06-29 17:01:22 +01:00
CONTRIBUTING Initial PR template. 2017-09-29 09:06:26 +01:00
INSTALL.rst update the install.rst to match reality 2018-04-01 01:06:54 +11:00
LICENSE Add Ciena to the contributors list 2018-07-19 15:47:23 -07:00
MANIFEST.in Ignore circle-ci files for setup.py. 2018-03-19 17:16:44 +00:00
NEWS.rst full changelog 2018-07-10 13:46:33 +10:00
pyproject.toml news.rst 2017-04-10 16:37:57 +10:00
README.rst update readme 2018-07-10 13:47:23 +10:00
setup.py Remove unused import 2017-10-02 21:10:09 -07:00
tox.ini replace various things with a single lint 2018-07-25 16:55:16 +10:00

Twisted
=======

|pypi|_
|coverage|_
|travis|_
|appveyor|_
|circleci|_

For information on what's new in Twisted 18.7.0, see the `NEWS <NEWS.rst>`_ file that comes with the distribution.


What is this?
-------------

Twisted is an event-based framework for internet applications, supporting Python 2.7 and Python 3.4+.
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 <http://twistedmatrix.com/documents/current/>`_.
This documentation contains how-tos, code examples, and an API reference.

Help is also available on the `Twisted mailing list <http://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 py34-tests # to run the tests for Python 3.4


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-2018 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.


.. |coverage| image:: https://codecov.io/github/twisted/twisted/coverage.svg?branch=trunk
.. _coverage: https://codecov.io/github/twisted/twisted

.. |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

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/x4oyqtl9cqc2i2l8
.. _appveyor: https://ci.appveyor.com/project/adiroiban/twisted

.. |circleci| image:: https://circleci.com/gh/twisted/twisted.svg?style=svg
.. _circleci: https://circleci.com/gh/twisted/twisted