Documentation
#############

:save_as: index.html

.. _Start here: http://twistedmatrix.com/documents/current/core/howto/index.html
.. |Start here| replace:: **Start here**

|Start here|_ , the developer guides for Twisted's core networking libraries. See also our many `examples <http://twistedmatrix.com/documents/current/core/examples/>`__ and the current `API reference <http://twistedmatrix.com/documents/current/api/>`_.

`Web Servers and Clients howtos <http://twistedmatrix.com/documents/current/web/howto/>`__ and `examples <http://twistedmatrix.com/documents/current/web/examples/>`__ . Want to use Twisted for **web development**? Please read `this page first! </sphinxwiki/content/pages/WebDevelopmentWithTwisted.html>`_


* Read our `FAQ </sphinxwiki/content/pages/FrequentlyAskedQuestions.html>`_.

* Documentation for other Twisted components:

  * SSH Servers and Clients - `howtos <http://twistedmatrix.com/documents/current/conch/howto/>`__ and `examples <http://twistedmatrix.com/documents/current/conch/examples/>`__.

  * Email protocols: SMTP, IMAP, POP3 - `STMP client tutorial <http://twistedmatrix.com/documents/current/mail/tutorial/smtpclient/smtpclient.html>`_ and `examples <http://twistedmatrix.com/documents/current/mail/examples/>`__.

  * DNS - `howtos <http://twistedmatrix.com/documents/current/names/howto/>`__ and `examples <http://twistedmatrix.com/documents/current/names/examples/>`__.

  * Instant messaging and  IRC - `howtos <http://twistedmatrix.com/documents/current/words/howto/>`__ and `examples <http://twistedmatrix.com/documents/current/words/examples/>`__.

* Twisted Core `man pages <http://twistedmatrix.com/documents/current/core/man/>`_.

* The complete developer guide in `PDF format <https://media.readthedocs.org/pdf/twisted/latest/twisted.pdf>`_.


Third Party Documentation
=========================

Dave Peticolas has written a number of `excellent tutorials <http://krondo.com/?page_id=1327>`_ on Twisted. They don't assume a lot of existing knowledge about networking or concurrency mechanisms, and as such are well-suited for new users. 

Developer Docs
==============

* Want to contribute? We have a page dedicated to `documentation for contributors </sphinxwiki/content/pages/ContributingToTwistedLabs.html>`_.
* Here are some notes about `Twisted Development </sphinxwiki/content/pages/Twisted/TwistedDevelopment.html>`_.

Mail Lists
==========

* Search the `twisted <http://www.mail-archive.com/twisted-python@twistedmatrix.com>`_ or `twisted-web <http://www.google.com/search?q=site%3Atwistedmatrix.com+inurl%3Apipermail%2Ftwisted-web&btnG=Search>`_ mail list archives.

Books
=====

* `Twisted Network Programming Essentials <http://www.amazon.com/exec/obidos/ASIN/1449326110/jpcalsjou-20>`_ by Abe Fettig & Jessica McKellar, published by O'Reilly.
* `Foundations of Python Network Programming <http://www.amazon.com/exec/obidos/ASIN/1590593715/jpcalsjou-20>`_ also covers the use of Twisted to some extent.
* `Game Programming With Python <http://www.amazon.com/exec/obidos/ASIN/1584502584/jpcalsjou-20>`_ covers Twisted in the chapters on programming networked games.