1 ===================

     2 pyams_utils package

     3 ===================

     4 

     5 .. contents::

     6 

     7 What is pyams_utils ?

     8 =====================

     9 

    10 pyams_utils is a set of classes and functions which can be used to provide many small services and

    11 handle common operations in the context of a Pyramid application.

    12 

    13 Internal sub-packages include :

    14  - date : convert dates to unicode ISO format, parse ISO datetime, convert date to datetime

    15  - request : get current request, get request annotations, get and set request data via annotations

    16  - timezone : convert datetime to a given timezone ; provides a server default timezone utility

    17  - traversing : get object parents until a given interface is implemented

    18  - unicode : convert any text to unicode for easy storage

    19  - protocol : utility functions and modules for several nerwork protocols

    20  - catalog : TextIndexNG index for Zope catalog and hurry.query "Text" query item

    21  - text : simple text operations and text to HTML conversion

    22  - html : HTML parser and HTML to text converter

    23  - file : file upload data converter

    24  - tal : text and HTML conversions for use from within TAL

    25 

    26 

    27 How to use pyams_utils ?

    28 ========================

    29 

    30 A set of pyams_utils usages are given as doctests in pyams_utils/doctests/README.txt