.. include:: links.txt

.. _index:

Rum's documentation
===================

.. note::
    
    The documentation of the development branch is always available
    `here </tip/>`_ It is generated by `our buildbot`_ so it is always
    up-to-date.

Introduction
=============

Rum is web application framework written in the `Python`_ language. It is not a
general-purpose web framework, but one which is specifically designed to create
generic RESTful web interfaces for your domain models. It is not designed to
replace your web-framework of choice but to complement it to create what are
commonly referred to as *Admin applications*.

Rum implements the WSGI interface so it can be deployed standalone
with any WSGI compliant server or it can be embedded into an
application/framework that can
dispatch to WSGI apps within its own stack (eg: Pylons or TurboGears2).
More information about how Rum can be deployed can be found in the :ref:`deploy`
document.

It is modeled following the Model-View-Controller pattern which makes it
loosely coupled. This allows, for example, to reuse the view layer with multiple
data backends (repositories in Rum parlance) and viceversa.
More information about the architecture can be found in the
:ref:`architecture` document.

Status
======

Rum is currently in an *beta* stage of development. This means that the APIs
are mostly stable but some change can be expected as real-world use demands.
Deprecation warnings will be given when this occurs so you can gracefully
upgrade your code.

It is recommended that you subscribe and follow the `rum-discuss`_ mailing list
to stay up-to-date with the development and ask for support.

Credits
=======

Rum was initially designed and implemented by Alberto Valverde Gonzalez and
sponsored by Google under the Summer of Code programme (2008) for the TurboGears
organization. Mark Ramm has been the mentor and contributed many good ideas.
Michael Brickenstein has contributed a significant amount of code and
implemented many features, he is now the co-lead developer.

License
=======

Rum is released under the terms of the :ref:`license`.

.. _community:

Community
=========

Discussion about Rum development and user support takes place in the
`rum-discuss`_ mailing list. There's a bug tracker at `Rum's Trac`_.

Contents
========

.. toctree::
   :maxdepth: 3

   user/index
   developer/index
   license
   glossary
   changelog

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

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