
:LastChangedDate: $LastChangedDate$
:LastChangedRevision: $LastChangedRevision$
:LastChangedBy: $LastChangedBy$

Setting up the TwistedQuotes application
========================================






Goal
----



This document describes how to set up the TwistedQuotes application used in
a number of other documents, such as :doc:`designing Twisted applications <design>` .





Setting up the TwistedQuotes project directory
----------------------------------------------



In order to run the Twisted Quotes example, you will need to do the
following:





#. Make a ``TwistedQuotes`` directory on your system
#. Place the following files in the ``TwistedQuotes`` directory:
   
   
   
   - 
   
     :download:`__init__.py <listings/TwistedQuotes/__init__.py>`
   
     .. literalinclude:: listings/TwistedQuotes/__init__.py
   
     (this
     file marks it as a package, see `this section <http://docs.python.org/tutorial/modules.html#packages>`_ of the Python tutorial for more on packages)
   - 
   
     :download:`quoters.py <listings/TwistedQuotes/quoters.py>`
   
     .. literalinclude:: listings/TwistedQuotes/quoters.py
   
   - 
   
     :download:`quoteproto.py <listings/TwistedQuotes/quoteproto.py>`
   
     .. literalinclude:: listings/TwistedQuotes/quoteproto.py
   
   
   
#. Add the ``TwistedQuotes`` directory's *parent* to your Python
   path. For example, if the TwistedQuotes directory's path is
   ``/mystuff/TwistedQuotes`` or ``c:\mystuff\TwistedQuotes`` 
   add ``/mystuff`` to your Python path. On UNIX this would be ``export PYTHONPATH=/mystuff${PYTHONPATH:+:$PYTHONPATH}
`` , on Microsoft
   Windows change the ``PYTHONPATH`` variable through the
   Systems Properties dialog by adding ``;c:\mystuff`` at the
   end.
#. 
   Test your package by trying to import it in the Python interpreter:
   
   .. code-block:: pycon
   
   
       Python 2.1.3 (#1, Apr 20 2002, 22:45:31)
       [GCC 2.95.4 20011002 (Debian prerelease)] on linux2
       Type "copyright", "credits" or "license" for more information.
       >>> import TwistedQuotes
       >>> # No traceback means you're fine.
   


