Initial commit

docs/source/api/client.rst

@@ -0,0 +1,10 @@
+:mod:`pyrad.client` -- basic client
+===================================
+
+.. automodule:: pyrad.client
+
+  .. autoclass:: Timeout
+    :members:
+
+  .. autoclass:: Client
+    :members:

docs/source/api/dictionary.rst

@@ -0,0 +1,10 @@
+:mod:`pyrad.dictionary` -- RADIUS dictionary
+============================================
+
+.. automodule:: pyrad.dictionary
+
+  .. autoclass:: ParseError
+    :members:
+
+  .. autoclass:: Dictionary
+    :members:

docs/source/api/host.rst

@@ -0,0 +1,7 @@
+:mod:`pyrad.host` -- RADIUS host definition
+===========================================
+
+.. automodule:: pyrad.host
+
+  .. autoclass:: Host
+    :members:

docs/source/api/packet.rst

@@ -0,0 +1,48 @@
+:mod:`pyrad.packet` -- packet encoding and decoding
+===================================================
+
+.. automodule:: pyrad.packet
+
+  .. autoclass:: Packet
+    :members:
+
+  .. autoclass:: AuthPacket
+    :members:
+
+  .. autoclass:: AcctPacket
+    :members:
+
+  .. autoclass:: CoAPacket
+    :members:
+
+  .. autoclass:: PacketError
+    :members:
+
+
+Constants
+---------
+
+The :mod:`pyrad.packet` module defines several common constants
+that are useful when dealing with RADIUS packets.
+
+The following packet codes are defined:
+
+==================    ======
+Constant name         Value
+==================    ======
+AccessRequest         1
+------------------    ------
+AccessAccept          2
+AccessReject          3
+AccountingRequest     4
+AccountingResponse    5
+AccessChallenge       11
+StatusServer          12
+StatusClient          13
+DisconnectRequest     40
+DisconnectACK         41
+DisconnectNAK         42
+CoARequest            43
+CoAACK                44
+CoANAK                45
+==================    ======

docs/source/api/proxy.rst

@@ -0,0 +1,7 @@
+:mod:`pyrad.proxy` -- basic proxy
+=================================
+
+.. automodule:: pyrad.proxy
+
+  .. autoclass:: Proxy
+    :members:

docs/source/api/server.rst

@@ -0,0 +1,13 @@
+:mod:`pyrad.server` -- basic server
+===================================
+
+.. automodule:: pyrad.server
+
+  .. autoclass:: RemoteHost
+    :members:
+
+  .. autoclass:: ServerPacketError
+    :members:
+
+  .. autoclass:: Server
+    :members: