← Back to branch summary

~hudson-openstack/nova/trunk

« back to all changes in this revision

Viewing changes to vendor/Twisted-10.0.0/README

  • Committer: Jesse Andrews
  • Date: 2010-05-28 06:05:26 UTC
  • Revision ID: git-v1:bf6e6e718cdc7488e2da87b21e258ccc065fe499
initial commit

Show diffs side-by-side

added added

removed removed

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