Incorporate broder code review number 2:
[invirt/packages/python-afs.git] / README.dev
1 This project is an attempt to develop a fully Python-based interface
2 to the AFS APIs. A lot of the structure is based on the Perl AFS
3 module (http://search.cpan.org/~nog/AFS-2.6.1), but this will
4 hopefully be a bit more Pythonic in its interface.
5
6 The goal is essentially to implement the full set of "high-level" APIs
7 provided by the Perl modules in a combination of Python and
8 Pyrex. This will typically involve a fairly simple wrapping of the C
9 API in a Pyrex module (e.g. afs._pts), and then a higher-level
10 wrapping of that Pyrex module in pure Python (e.g. afs.pts).
11
12 I am depending on patches from other people, beacuse I will not finish
13 this on my own. I think I've established enough of the structure that
14 others can see what I want the structure to look like.
15
16 Please be sure to sign off on your patches.