summaryrefslogtreecommitdiffstats
path: root/ipapython/README
diff options
context:
space:
mode:
Diffstat (limited to 'ipapython/README')
-rw-r--r--ipapython/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/ipapython/README b/ipapython/README
new file mode 100644
index 00000000..c966e44b
--- /dev/null
+++ b/ipapython/README
@@ -0,0 +1,18 @@
+This is a set of libraries common to IPA clients and servers though mostly
+geared currently towards command-line tools.
+
+A brief overview:
+
+config.py - identify the IPA server domain and realm. It uses dnsclient to
+ try to detect this information first and will fall back to
+ /etc/ipa/ipa.conf if that fails.
+dnsclient.py - find IPA information via DNS
+
+ipautil.py - helper functions
+
+radius_util.py - helper functions for Radius
+
+entity.py - entity is the main data type. User and Group extend this class
+ (but don't add anything currently).
+
+ipavalidate.py - basic data validation routines