refactor structure

Author: ohmrefresh

.travis.yml

@@ -14,4 +14,4 @@ deploy:
   on:
     tags: true
     distributions: sdist bdist_wheel
-    repo: ohmrefresh/GrafanaSnapshotLibrary
+    repo: ohmrefresh/GrafanaSnapshot

GrafanaSnapshotLibrary/GenerateSnapshot.py renamed to GrafanaSnapshot/GenerateSnapshot.py

@@ -11,7 +11,17 @@ class GenerateSnapshot:
     def __init__(self, auth, host, port, protocol):
         self.api = GrafanaFace(auth=auth, host=host, port=port, protocol=protocol, verify=False)
 
-    def generate(self, tags, time_from, time_to):
+    def generate(self, tags, time_from, time_to, expires=300):
+
+        """
+        Generate Grafana snapshot with expires
+        :param tags:
+        :param time_from:
+        :param time_to:
+        :param expires:
+        :return:
+        """
+
         dashboards_info = self.api.search.search_dashboards(tag=tags)
         dashboards = {}
         for dashboard_info in dashboards_info:
@@ -29,10 +39,9 @@ def generate(self, tags, time_from, time_to):
             snapshot_name = "{}_{}_{}".format(uri.replace("db/", ""), dashboard["time"]["from"],
                                               dashboard["time"]["to"])
 
-            snapshot = self.api.snapshots.create_new_snapshot(dashboard, name=snapshot_name, expires=300)
+            snapshot = self.api.snapshots.create_new_snapshot(dashboard, name=snapshot_name, expires=expires)
             snapshot_list.append(snapshot)
 
-        print(snapshot_list)
         return snapshot_list
 
     @staticmethod

GrafanaSnapshotLibrary/__init__.py renamed to GrafanaSnapshot/__init__.py

@@ -2,25 +2,23 @@
 
 # Current status in development
 
+## Install
+If you want to use the API algorithms in your code, it is as simple as:
 
-# grafana_api = GrafanaFace(auth='',
-#                           host='xx', port=3000, protocol="https", verify=False)
-
-#
-# dashboards_info = grafana_api.search.search_dashboards(tag='tags')
-# print(dashboards_info)
-# dashboards = {}
-# for dashboard_info in dashboards_info:
-#     uid = dashboard_info["uid"]
-#     dashboards[dashboard_info['uri']] = grafana_api.dashboard.get_dashboard(uid);
-#
-# snapshot_list = []
-# for uri, dashboard in dashboards.items():
-#     dashboard = dashboard["dashboard"] if "dashboard" in dashboard else dashboard
-#     if time_from:
-#         dashboard["time"]["from"] = time_str_from_unix_ms(time_from)
-#     if time_to:
-#         dashboard["time"]["to"] = time_str_from_unix_ms(time_to)
-#     snapshot = grafana_api.snapshots.create_new_snapshot(dashboard, name=uri.replace("db/", ""),expires=300)
-#     print(snapshot)
- 
+    $ pip3 install grafana-snapshot
+
+You can test by creating a python file:
+
+```python3
+from GenerateSnapshot import GenerateSnapshot
+
+if __name__ == "__main__":
+    grafana = GenerateSnapshot(auth='', host='xx', port=3000, protocol="https", verify=False)
+    grafana.generate(tags="tags", time_from="1563183710618", time_to="1563185212275")
+
+```
+
+## Uninstall
+If you want to uninstall grafana-snapshot, it is as simple as:
+
+    $ pip3 uninstall -y grafana-snapshot

GrafanaSnapshotLibrary/version.py renamed to GrafanaSnapshot/version.py

@@ -5,7 +5,7 @@
 import setuptools
 
 # Read version from file without loading the module
-with open('GrafanaSnapshotLibrary/version.py', 'r') as version_file:
+with open('GrafanaSnapshot/version.py', 'r') as version_file:
     version_match = re.search(r"^VERSION ?= ?['\"]([^'\"]*)['\"]",
                               version_file.read(), re.M)
 with open("README.md", "r") as fh:
@@ -32,14 +32,14 @@
 ]
 
 setuptools.setup(
-    name="GrafanaSnapshotLibrary",
+    name="grafana-snapshot",
     version=VERSION,
     author="Authapon Kongkaew",
     author_email="[email protected]",
     description="A small example package",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/ohmrefresh/GrafanaSnapshotLibrary.git",
+    url="https://github.com/ohmrefresh/GrafanaSnapshot.git",
     install_requires=requirements,
     packages=setuptools.find_packages(),
     classifiers=[