=================
cofan Tutorial
=================

.. warning::
  This tutorial is out of date and is not applicable to cofan version 1.

This tutorial gives an introduction to how to use cofan python library and its
features.

This is not a python tutorial. You are expected to have general knowledge in
python before you start this tutorial.

-----------
About cofan
-----------

`cofan` is an http server library. It is similar to python standard
`http.server` libarary but with the following features:

    * Serve the content of a local directory as a file browser with icons for
      directories and files based on their extension.
    * Serve the content of a local zip file the same way as the local
      directories.
    * List the content of a local directory in json form.
    * Serve local html files as a web site.
    * Organize your urls in prefix trees.
    * Response differently for different ip addresses

To put it short, look at the following screenshot comparison of `http.server`
and `cofan`.

.. figure:: _static/comparison-with-http-server.png
    
    Comparison of `http.server` web page (left) and `cofan` (right)

-------
Content
-------

.. toctree::
    :maxdepth: 2

    installation
    quick-guide
    serving-a-local-dir
    showing-icons
    serving-multiple-dirs
    listing-prefixes
    serving-zip-files
    other-features
    reference
   

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`