10 pyams_utils package |
10 pyams_utils package |
11 =================== |
11 =================== |
12 |
12 |
13 .. contents:: |
13 .. contents:: |
14 |
14 |
|
15 |
15 What is pyams_utils ? |
16 What is pyams_utils ? |
16 ===================== |
17 ===================== |
17 |
18 |
18 pyams_utils is a set of classes and functions which can be used to provide many small services and |
19 pyams_utils is a set of classes and functions which can be used to provide many small services and |
19 handle common operations in the context of a Pyramid application. |
20 handle common operations in the context of a Pyramid application. |
20 |
21 |
21 Internal sub-packages include : |
22 Internal sub-packages include: |
22 - date : convert dates to unicode ISO format, parse ISO datetime, convert date to datetime |
23 - registry: local registry management tools |
23 - request : get current request, get request annotations, get and set request data via annotations |
24 - adapter: custom adapters and annotations |
24 - timezone : convert datetime to a given timezone ; provides a server default timezone utility |
25 - date: convert dates to unicode ISO format, parse ISO datetime, convert date to datetime |
25 - traversing : get object parents until a given interface is implemented |
26 - request: get current request, get request annotations, get and set request data via annotations |
26 - unicode : convert any text to unicode for easy storage |
27 - session: to store and get properties values from current session |
27 - protocol : utility functions and modules for several nerwork protocols |
28 - timezone: convert datetime to a given timezone ; provides a server default timezone utility |
28 - catalog : TextIndexNG index for Zope catalog and hurry.query "Text" query item |
29 - traversing: custom traverser utility supporting namespaces |
29 - text : simple text operations and text to HTML conversion |
30 - unicode: convert any text to unicode for easy storage |
30 - html : HTML parser and HTML to text converter |
31 - protocol: utility functions and modules for several nerwork protocols |
31 - file : file upload data converter |
32 - text: simple text operations and text to HTML conversion |
32 - tal : text and HTML conversions for use from within TAL |
33 - html: HTML parser and HTML to text converter |
|
34 - file: file upload data converter |
|
35 - tales: custom "extension:" TALES expression using adapters |
33 |
36 |
34 |
37 |
35 How to use pyams_utils ? |
38 How to use pyams_utils ? |
36 ======================== |
39 ======================== |
37 |
40 |
38 A set of pyams_utils usages are given as doctests in pyams_utils/doctests/README.txt |
41 A set of pyams_utils usages are given as doctests in pyams_utils/doctests/README.txt |
39 |
42 |
|
43 You will also a whole set of documentations into the "docs" directory, available on |
|
44 `ReadTheDocs <http://pyams-utils.readthedocs.org>`_ |
|
45 |
40 |
46 |
41 Changelog |
47 Changelog |
42 ========= |
48 ========= |
|
49 |
|
50 0.1.4 |
|
51 ----- |
|
52 - added "condition" optional argument to "get_parent" traversing helper to retrieve a parent only if given function |
|
53 returns a "True" value when called with parent as argument |
|
54 - added annotation for vocabulary registry |
|
55 - added 'prefix' argument to 'request_property' and 'session_property' decorators |
|
56 - handle POSError in 'query_utility' registry function |
|
57 - updated unit tests |
|
58 - updated documentation |
43 |
59 |
44 0.1.3 |
60 0.1.3 |
45 ----- |
61 ----- |
46 - corrected XML-RPC client for Python 3 |
62 - corrected XML-RPC client for Python 3 |
47 - added container's "find_objects_*" functions based on ISubLocations interface |
63 - added container's "find_objects_*" functions based on ISubLocations interface |