Documentation

• Read our FAQ.
• Want to use Twisted for web development? Please read this page first!
• ​Core Documentation (​view as PDF) - the code developer guide for Twisted Core, with the famous "Finger" tutorial, details on how to use deferreds, etc.
• Twisted Core ​man pages.
• Twisted Core ​examples.
• View the current ​API reference.
• The project pages have documentation links that are pertinent to each Twisted project. For convenience, we offer some of these links below:
  • conch (SSH protocol) - ​howtos and ​examples
  • lore (documentation) - ​howtos and ​examples
  • mail (SMTP protocol) - ​client tutorial and ​examples
  • names (DNS protocol) - ​howtos and ​examples
  • trial (testing framework) - docs
  • web (HTTP protocol) - ​howtos and ​examples
  • web2 (HTTP protocol now defunct, see TwistedWebPlan) - ​howtos and ​examples
  • words (instant messaging) - ​howtos and ​examples

Developer Docs

• Want to contribute? We have a page dedicated to documentation for contributors.
• Here are some notes about Twisted Development.

Mail Lists

• Search the ​twisted-python or ​twisted-web mail list archives.

Books

• ​Twisted Network Programming Essentials by Abe Fettig, published by O'Reilly.
• ​Foundations of Python Network Programming also covers the use of Twisted to some extent.
• ​Game Programming With Python covers Twisted in the chapters on programming networked games.