From 75204dcd93a06699669e51f6e34487aacbcde6a7 Mon Sep 17 00:00:00 2001
From: Jonas Gunz <himself@jonasgunz.de>
Date: Fri, 11 Dec 2020 01:08:37 +0100
Subject: error handling, doc

---
 phpipam/__init__.py | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

(limited to 'phpipam/__init__.py')

diff --git a/phpipam/__init__.py b/phpipam/__init__.py
index 89d8280..caf217e 100755
--- a/phpipam/__init__.py
+++ b/phpipam/__init__.py
@@ -4,12 +4,31 @@ from .resources import phpipamResource
 class phpipam:
     """
     phpIPAM API Implementation
-    ReadOnly because I don't need the writing bit
+
+    Attributes
+    ----------
+    sections
+    subnets
+    addresses
+    devices
 
     https://phpipam.net/api-documentation/
     """
 
     def __init__(self, api_url, app_id, api_user, api_password):
+        """
+        Parameters
+        ----------
+        api_url : str
+            URL of phpIPAM instance. Example: https://phpipam.example.com/
+        app_id : str
+            AppID configrued in API settings
+        api_user : str
+            username, leave empty to use static token authentification
+        api_password : str
+            password or static authentification token
+        """
+
         self._backend = phpipamBackend(api_url, app_id, api_user, api_password)
 
     def __getattr__(self, item):
-- 
cgit v1.2.3