README 3.8 KB

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