bottle-utils 1.0

============
Bottle utils
============

Assortment of frequently used utilities for Bottle.

This package contains utilities for developing web sites and web applications
using `Bottle <http://bottlepy.org/>`_ framework. It is divided into several
modules of which the ``lazy`` module is not Bottle-specific.

The bottle-utils are created from a bunch of unrelated modules we frequently
used at `Outernet <https://outernet.is/>`_. Some of the modules have been
tested fairly thoroughly, and some have been used only in a handful of
projects. Therefore, not all modules are of high quality. You should conisder
this package Alpha quality.

Installation
============

Install using ``pip`` or ``easy_install``::

pip install bottle-utils

easy_install bottle-utils

.. note::
Between versions 0.3 and 0.5, bottle-utils have been split into multiple
packages. Since 0.5, they have been remerged into a single packages as we
normally use them together, and having them as separate packages causes
various deployment issues.

Documentation
=============

Detailed documentation is available `online
<http://bottle-utils.readthedocs.org/>`_.

You can also generate offline documentation by cloning this repository and
doing the following::

cd /path/to/repo
cd docs
make html

The ``docs/build/html`` directory should contain full HTML documentation. You
can start from the ``index.html`` file.

Bugs
====

Please report all bugs to our `GitHub issue tracker`_.

License
=======

This package is licensed under BSD license. See LICENSE_ for more
info.

.. _Bottle: http://bottlepy.org/
.. _Outernet: https://www.outernet.is/
.. _GitHub issue tracker: https://github.com/Outernet-Project/bottle-utils/issues
.. _LICENSE: LICENSE