diff -r 000000000000 -r c8e21d7dd685 docs/README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/README.txt Wed Dec 05 12:45:56 2018 +0100 @@ -0,0 +1,36 @@ +=================== +pyams_utils package +=================== + +.. contents:: + + +What is pyams_utils ? +===================== + +pyams_utils is a set of classes and functions which can be used to provide many small services and +handle common operations in the context of a Pyramid application. + +Internal sub-packages include: + - registry: local registry management tools + - adapter: custom adapters and annotations + - date: convert dates to unicode ISO format, parse ISO datetime, convert date to datetime + - request: get current request, get request annotations, get and set request data via annotations + - session: to store and get properties values from current session + - timezone: convert datetime to a given timezone ; provides a server default timezone utility + - traversing: custom traverser utility supporting namespaces + - unicode: convert any text to unicode for easy storage + - protocol: utility functions and modules for several nerwork protocols + - text: simple text operations and text to HTML conversion + - html: HTML parser and HTML to text converter + - file: file upload data converter + - tales: custom "extension:" TALES expression using adapters + + +How to use pyams_utils ? +======================== + +A set of pyams_utils usages are given as doctests in pyams_utils/doctests/README.txt + +You will also a whole set of documentations into the "docs" directory, available on +`ReadTheDocs `_