1 =================== |
1 =================== |
2 pyams_utils package |
2 pyams_utils package |
3 =================== |
3 =================== |
4 |
4 |
5 .. contents:: |
5 .. contents:: |
|
6 |
6 |
7 |
7 What is pyams_utils ? |
8 What is pyams_utils ? |
8 ===================== |
9 ===================== |
9 |
10 |
10 pyams_utils is a set of classes and functions which can be used to provide many small services and |
11 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 handle common operations in the context of a Pyramid application. |
12 |
13 |
13 Internal sub-packages include : |
14 Internal sub-packages include: |
14 - date : convert dates to unicode ISO format, parse ISO datetime, convert date to datetime |
15 - registry: local registry management tools |
15 - request : get current request, get request annotations, get and set request data via annotations |
16 - adapter: custom adapters and annotations |
16 - timezone : convert datetime to a given timezone ; provides a server default timezone utility |
17 - date: convert dates to unicode ISO format, parse ISO datetime, convert date to datetime |
17 - traversing : get object parents until a given interface is implemented |
18 - request: get current request, get request annotations, get and set request data via annotations |
18 - unicode : convert any text to unicode for easy storage |
19 - session: to store and get properties values from current session |
19 - protocol : utility functions and modules for several nerwork protocols |
20 - timezone: convert datetime to a given timezone ; provides a server default timezone utility |
20 - catalog : TextIndexNG index for Zope catalog and hurry.query "Text" query item |
21 - traversing: custom traverser utility supporting namespaces |
21 - text : simple text operations and text to HTML conversion |
22 - unicode: convert any text to unicode for easy storage |
22 - html : HTML parser and HTML to text converter |
23 - protocol: utility functions and modules for several nerwork protocols |
23 - file : file upload data converter |
24 - text: simple text operations and text to HTML conversion |
24 - tal : text and HTML conversions for use from within TAL |
25 - html: HTML parser and HTML to text converter |
|
26 - file: file upload data converter |
|
27 - tales: custom "extension:" TALES expression using adapters |
25 |
28 |
26 |
29 |
27 How to use pyams_utils ? |
30 How to use pyams_utils ? |
28 ======================== |
31 ======================== |
29 |
32 |
30 A set of pyams_utils usages are given as doctests in pyams_utils/doctests/README.txt |
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>`_ |