README

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