aboutsummaryrefslogtreecommitdiff
path: root/rpkid/rpki/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'rpkid/rpki/__init__.py')
-rw-r--r--rpkid/rpki/__init__.py42
1 files changed, 42 insertions, 0 deletions
diff --git a/rpkid/rpki/__init__.py b/rpkid/rpki/__init__.py
new file mode 100644
index 00000000..610edbb3
--- /dev/null
+++ b/rpkid/rpki/__init__.py
@@ -0,0 +1,42 @@
+# $Id$
+
+# Copyright (C) 2007--2008 American Registry for Internet Numbers ("ARIN")
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND ARIN DISCLAIMS ALL WARRANTIES WITH
+# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+# AND FITNESS. IN NO EVENT SHALL ARIN BE LIABLE FOR ANY SPECIAL, DIRECT,
+# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+# PERFORMANCE OF THIS SOFTWARE.
+
+# This file exists to tell Python that this the content of this
+# directory constitute a Python package. Since we're not doing
+# anything exotic, this file doesn't need to contain any code, but
+# since its existance defines the package, it's as sensible a place as
+# any to put the Doxygen mainpage.
+
+## @mainpage
+##
+## This collection of Python modules implements a prototype of the
+## RPKI Engine. This is a work in progress.
+##
+## See http://viewvc.hactrn.net/subvert-rpki.hactrn.net/ for code,
+## design documents, a text mirror of portions of APNIC's Wiki, etc.
+##
+## The documentation you're reading is generated automatically by
+## Doxygen from comments and documentation in
+## <a href="http://viewvc.hactrn.net/subvert-rpki.hactrn.net/rpkid/rpki/">the code</a>.
+##
+## This work is funded by <a href="http://www.arin.net/">ARIN</a>, in
+## collaboration with the other RIRs. If you're interested in this
+## package you might also be interested in:
+##
+## @li <a href="http://viewvc.hactrn.net/subvert-rpki.hactrn.net/rcynic/">the rcynic validation tool</a>
+## @li <a href="http://www.hactrn.net/opaque/rcynic.html">a sample of rcynic's summary output</a>
+## @li <a href="http://mirin.apnic.net/resourcecerts/wiki/">APNIC's Wiki</a>
+## @li <a href="http://mirin.apnic.net/trac/">APNIC's project Trac instance</a>