← Back to branch summary

~ar-python-hackers/authentication-results-python/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: Scott Kitterman
  • Date: 2014-06-25 10:20:14 UTC
  • Revision ID: scott@kitterman.com-20140625102014-vfsd1jptyrds24kk
Tags: 0.700
 * Updated README and docstrings to refer to RFC 7001 in addition to RFC 5451

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
1
This module (authres) is designed to provide support for RFC 5451/7001,
2
 
http://tools.ietf.org/html/rfc5451,  processing in Python.
 
2
originally http://tools.ietf.org/html/rfc5451 and currently
 
3
http://tools.ietf.org/html/rfc7001, processing in Python.
3
4
 
4
5
It also supports Authentication Results extensions:
5
6
 
16
17
 
17
18
Header folding and unfolding is the responsibility of the calling application.
18
19
 
19
 
Between docstrings and RFC 5451 the API should be reasonably clear, but the
 
20
Between docstrings and RFC 5451/7001 the API should be reasonably clear, but the
20
21
docstrings are still a work in progress.  Additional examples are available in
21
22
the file authres/tests.  The API is completely reworked from version 0.1.
22
23
 
23
24
This package requires python2.6 or later (including python3). It has been
24
 
tested with python2.6, python2.7, python3.2, and python3.3.
 
25
tested with python2.6, python2.7, python3.2, python3.3, and python3.4.
25
26
 
26
 
To execute doctests, run the module as main: python -m authres.__main__
 
27
To execute doctests, run the module as main: python -m authres
27
28
 
28
29
This is completely untested on Windows, but in theory should work.