Rename module names and references

Author: amotl

README.md

@@ -34,15 +34,16 @@ Install the package from PyPI.
 pip install grafana-client --upgrade
 ```
 
-Connect to your Grafana API endpoint using the `GrafanaFace` interface.
+Connect to your Grafana API endpoint using the `GrafanaApi` class.
 
 ```python
-from grafana_client.grafana_face import GrafanaFace
+from grafana_client import GrafanaApi
 
-grafana = GrafanaFace(auth='abcde....', host='grafana.example.org')
+grafana = GrafanaApi(auth='abcde....', host='grafana.example.org')
 
 # Create user
-user = grafana.admin.create_user({"name": "User", "email": "[email protected]", "login": "user", "password": "userpassword", "OrgId": 1})
+user = grafana.admin.create_user(
+    {"name": "User", "email": "[email protected]", "login": "user", "password": "userpassword", "OrgId": 1})
 
 # Change user password
 user = grafana.admin.change_user_password(2, "newpassword")
@@ -63,7 +64,7 @@ grafana.dashboard.update_dashboard(dashboard={'dashboard': {...}, 'folderId': 0,
 grafana.dashboard.delete_dashboard(dashboard_uid='abcdefgh')
 
 # Create organization
-grafana.organization.create_organization({"name":"new_organization"})
+grafana.organization.create_organization({"name": "new_organization"})
 ```
 
 
@@ -75,18 +76,17 @@ or HTTP basic auth.
 To use the admin API, you need to use HTTP basic auth, as stated at the
 [Grafana Admin API documentation].
 
-
 ```python
-from grafana_client.grafana_face import GrafanaFace
+from grafana_client import GrafanaApi
 
 # Use HTTP basic authentication
-grafana = GrafanaFace(
+grafana = GrafanaApi(
     auth=("username", "password"),
     host='grafana.example.org'
 )
 
 # Use Grafana API token
-grafana = GrafanaFace(
+grafana = GrafanaApi(
     auth='eyJrIjoiWHg...dGJpZCI6MX0=',
     host='grafana.example.org'
 )

conda/meta.yaml

@@ -24,7 +24,7 @@ requirements:
 test:
   imports:
     - grafana_client
-    - grafana_client.api
+    - grafana_client.elements
 
 about:
   home: https://panodata.github.io/grafana-client/

grafana_client/__init__.py

@@ -1 +1 @@
-from .grafana_face import GrafanaFace
+from .api import GrafanaApi

grafana_client/api.py

@@ -0,0 +1,51 @@
+from .client import GrafanaClient
+from .elements import (
+    Admin,
+    Dashboard,
+    Datasource,
+    Folder,
+    Organization,
+    Organizations,
+    Search,
+    User,
+    Users,
+    Teams,
+    Snapshots,
+    Annotations,
+    Notifications
+)
+
+
+class GrafanaApi:
+    def __init__(
+        self,
+        auth,
+        host="localhost",
+        port=None,
+        url_path_prefix="",
+        protocol="http",
+        verify=True,
+        timeout=5.0,
+    ):
+        self.client = GrafanaClient(
+            auth,
+            host=host,
+            port=port,
+            url_path_prefix=url_path_prefix,
+            protocol=protocol,
+            verify=verify,
+            timeout=timeout,
+        )
+        self.admin = Admin(self.client)
+        self.dashboard = Dashboard(self.client)
+        self.datasource = Datasource(self.client)
+        self.folder = Folder(self.client)
+        self.organization = Organization(self.client)
+        self.organizations = Organizations(self.client)
+        self.search = Search(self.client)
+        self.user = User(self.client)
+        self.users = Users(self.client)
+        self.teams = Teams(self.client)
+        self.annotations = Annotations(self.client)
+        self.snapshots = Snapshots(self.client)
+        self.notifications = Notifications(self.client)

grafana_client/api/base.py

@@ -56,7 +56,7 @@ def __call__(self, request):
         return request
 
 
-class GrafanaAPI:
+class GrafanaClient:
     def __init__(
         self,
         auth,

grafana_client/grafana_api.py renamed to grafana_client/client.py

@@ -2,17 +2,17 @@
 
 
 class Admin(Base):
-    def __init__(self, api):
-        super(Admin, self).__init__(api)
-        self.api = api
+    def __init__(self, client):
+        super(Admin, self).__init__(client)
+        self.client = client
 
     def settings(self):
         """
 
         :return:
         """
         path = "/admin/settings"
-        r = self.api.GET(path)
+        r = self.client.GET(path)
         return r
 
     def stats(self):
@@ -21,7 +21,7 @@ def stats(self):
         :return:
         """
         path = "/admin/stats"
-        r = self.api.GET(path)
+        r = self.client.GET(path)
         return r
 
     def create_user(self, user):
@@ -31,7 +31,7 @@ def create_user(self, user):
         :return:
         """
         create_user_path = "/admin/users"
-        r = self.api.POST(create_user_path, json=user)
+        r = self.client.POST(create_user_path, json=user)
         return r
 
     def change_user_password(self, user_id, password):
@@ -42,7 +42,7 @@ def change_user_password(self, user_id, password):
         :return:
         """
         change_user_password_path = "/admin/users/%s/password" % user_id
-        r = self.api.PUT(change_user_password_path, json={"password": password})
+        r = self.client.PUT(change_user_password_path, json={"password": password})
         return r
 
     def change_user_permissions(self, user_id, is_grafana_admin):
@@ -53,7 +53,7 @@ def change_user_permissions(self, user_id, is_grafana_admin):
         :return:
         """
         change_user_permissions = "/admin/users/%s/permissions" % user_id
-        r = self.api.PUT(
+        r = self.client.PUT(
             change_user_permissions, json={"isGrafanaAdmin": is_grafana_admin}
         )
         return r
@@ -65,7 +65,7 @@ def delete_user(self, user_id):
         :return:
         """
         delete_user_path = "/admin/users/%s" % user_id
-        r = self.api.DELETE(delete_user_path)
+        r = self.client.DELETE(delete_user_path)
         return r
 
     def pause_all_alerts(self, pause):
@@ -75,5 +75,5 @@ def pause_all_alerts(self, pause):
         :return:
         """
         change_user_permissions = "/admin/pause-all-alerts"
-        r = self.api.POST(change_user_permissions, json={"paused": pause})
+        r = self.client.POST(change_user_permissions, json={"paused": pause})
         return r

grafana_client/api/__init__.py renamed to grafana_client/elements/__init__.py

@@ -2,9 +2,9 @@
 
 
 class Annotations(Base):
-    def __init__(self, api):
-        super(Annotations, self).__init__(api)
-        self.api = api
+    def __init__(self, client):
+        super(Annotations, self).__init__(client)
+        self.client = client
 
     def get_annotation(
         self,
@@ -67,7 +67,7 @@ def get_annotation(
         list_annotations_path += "?"
         list_annotations_path += "&".join(params)
 
-        r = self.api.GET(list_annotations_path)
+        r = self.client.GET(list_annotations_path)
 
         return r
 
@@ -103,7 +103,7 @@ def add_annotation(
             "text": text,
         }
 
-        r = self.api.POST(annotations_path, json=payload)
+        r = self.client.POST(annotations_path, json=payload)
 
         return r
 
@@ -132,7 +132,7 @@ def add_annotation_graphite(
             "data": data
         }
 
-        r = self.api.POST(annotations_path, json=payload)
+        r = self.client.POST(annotations_path, json=payload)
 
         return r
 
@@ -161,7 +161,7 @@ def update_annotation(
             "text": text
         }
 
-        r = self.api.PUT(annotations_path, json=payload)
+        r = self.client.PUT(annotations_path, json=payload)
 
         return r
 
@@ -193,7 +193,7 @@ def partial_update_annotation(
             "text": text
         }
 
-        r = self.api.PATCH(annotations_path, json=payload)
+        r = self.client.PATCH(annotations_path, json=payload)
 
         return r
 
@@ -209,6 +209,6 @@ def delete_annotations_by_id(
         :return:
         """
         annotations_path = "/annotations/{}".format(annotations_id)
-        r = self.api.DELETE(annotations_path)
+        r = self.client.DELETE(annotations_path)
 
         return r

grafana_client/api/admin.py renamed to grafana_client/elements/admin.py

@@ -0,0 +1,3 @@
+class Base(object):
+    def __init__(self, client):
+        self.client = client