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

     2 pyams_utils package

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

     4 

     5 .. contents::

     6 

     7 

     8 What is pyams_utils ?

     9 =====================

    10 

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

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

    13 

    14 Internal sub-packages include:

    15  - registry: local registry management tools

    16  - adapter: custom adapters and annotations

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

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

    19  - session: to store and get properties values from current session

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

    21  - traversing: custom traverser utility supporting namespaces

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

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

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

    25  - html: HTML parser and HTML to text converter

    26  - file: file upload data converter

    27  - tales: custom "extension:" TALES expression using adapters

    28 

    29 

    30 How to use pyams_utils ?

    31 ========================

    32 

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

    34 

    35 You will also a whole set of documentations into the "docs" directory, available on

    36 `ReadTheDocs <http://pyams-utils.readthedocs.org>`_