README

   1 Twisted 10.2.0
   2
   3 Quote of the Release:
   4
   5   <glyph> khorn: "I know what you're thinking.  'Did he add six callbacks or
   6           only five?'  Well, to tell you the truth, in all this excitement, I
   7           kind of lost track myself.  But being as this is a Deferred, the most
   8           powerful callback abstraction in the world, and would blow your head
   9           clean off, you've got to ask yourself one question: do you know how
  10           to add callbacks?  well, do ya, punk?"
  11
  12
  13 For information on what's new in Twisted 10.2.0, see the NEWS file that comes
  14 with the distribution.
  15
  16 What is this?
  17 =============
  18
  19   Twisted is an event-based framework for internet applications.  It includes
  20   modules for many different purposes, including the following:
  21
  22   - twisted.application
  23     A "Service" system that allows you to organize your application in
  24     hierarchies with well-defined startup and dependency semantics,
  25   - twisted.cred
  26     A general credentials and authentication system that facilitates
  27     pluggable authentication backends,
  28   - twisted.enterprise
  29     Asynchronous database access, compatible with any Python DBAPI2.0
  30     modules,
  31   - twisted.internet
  32     Low-level asynchronous networking APIs that allow you to define
  33     your own protocols that run over certain transports,
  34   - twisted.manhole
  35     A tool for remote debugging of your services which gives you a
  36     Python interactive interpreter,
  37   - twisted.protocols
  38     Basic protocol implementations and helpers for your own protocol
  39     implementations,
  40   - twisted.python
  41     A large set of utilities for Python tricks, reflection, text
  42     processing, and anything else,
  43   - twisted.spread
  44     A secure, fast remote object system,
  45   - twisted.trial
  46     A unit testing framework that integrates well with Twisted-based code.
  47
  48   Twisted supports integration of the Win32, Tk, GTK+ and GTK+ 2 event loops
  49   with its main event loop.  There is experimental support for Mac OS X and
  50   wxPython event loop integration, which you use at your peril.
  51
  52   For more information, visit http://www.twistedmatrix.com, or join the list
  53   at http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
  54
  55   There are many official Twisted subprojects, including clients and
  56   servers for web, mail, DNS, and more. You can find out more about
  57   these projects at http://twistedmatrix.com/trac/wiki/TwistedProjects
  58
  59
  60 Installing
  61 ==========
  62
  63   Instructions for installing this software are in INSTALL.
  64
  65 Unit Tests
  66 ==========
  67
  68
  69   See our unit tests run proving that the software is BugFree(TM):
  70
  71    % trial twisted
  72
  73   Some of these tests may fail if you
  74    * don't have the dependancies required for a particular subsystem installed,
  75    * have a firewall blocking some ports (or things like Multicast, which Linux
  76      NAT has shown itself to do), or
  77    * run them as root.
  78
  79
  80 Documentation and Support
  81 =========================
  82
  83   Examples on how to use Twisted APIs are located in doc/core/examples; this
  84   might ease the learning curve a little bit, since all these files are kept
  85   as short as possible.  The file doc/core/howto/index.xhtml contains an index
  86   of all the core HOWTOs: this should be your starting point when looking for
  87   documentation.
  88
  89   Help is available on the Twisted mailing list:
  90
  91     http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
  92
  93   There is also a very lively IRC channel, #twisted, on
  94   chat.freenode.net.
  95
  96
  97 Copyright
  98 =========
  99
 100   All of the code in this distribution is Copyright (c) 2001-2010
 101   Twisted Matrix Laboratories.
 102
 103   Twisted is made available under the MIT license. The included
 104   LICENSE file describes this in detail.
 105
 106
 107 Warranty
 108 ========
 109
 110   THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
 111   EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 112   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
 113   TO THE USE OF THIS SOFTWARE IS WITH YOU.
 114
 115   IN NO EVENT WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
 116   AND/OR REDISTRIBUTE THE LIBRARY, BE LIABLE TO YOU FOR ANY DAMAGES, EVEN IF
 117   SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 118   DAMAGES.
 119
 120   Again, see the included LICENSE file for specific legal details.