Merge pull request #17 from davidban77/projects-and-template-summary

Projects and template summary

.circleci/config.yml

@@ -20,8 +20,8 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - deps-{{ checksum "poetry.lock" }}
-            # - deps-clear
+            # - deps-{{ checksum "poetry.lock" }}
+            - deps-clear
       - run:
           name: Install Dependencies
           command: |
@@ -39,8 +39,8 @@ jobs:
           command: |
             poetry run tox
       - save_cache:
-          key: deps-{{ checksum "poetry.lock" }}
-          # key: deps-clear
+          # key: deps-{{ checksum "poetry.lock" }}
+          key: deps-clear
           paths:
             - /home/circleci/.cache/pypoetry/virtualenvs
             - /home/circleci/.cache/.tox

README.md

@@ -28,10 +28,26 @@ For example:
 
 ```python
 >>> import gns3fy
+>>> from tabulate import tabulate
 
 # Define the server object to establish the connection
 >>> gns3_server = gns3fy.Gns3Connector("http://<server address>:3080")
 
+# Show the available projects on the server
+>>> print(
+        tabulate(
+            gns3_server.projects_summary(is_print=False),
+            headers=["Project Name", "Project ID", "Total Nodes", "Total Links", "Status"],
+        )
+    )
+"""
+Project Name    Project ID                              Total Nodes    Total Links  Status
+--------------  ------------------------------------  -------------  -------------  --------
+test2           c9dc56bf-37b9-453b-8f95-2845ce8908e3             10              9  opened
+API_TEST        4b21dfb3-675a-4efa-8613-2f7fb32e76fe              6              4  opened
+mpls-bgpv2      f5de5917-0ac5-4850-82b1-1d7e3c777fa1             30             40  closed
+"""
+
 # Define the lab you want to load and assign the server connector
 >>> lab = gns3fy.Project(name="API_TEST", connector=gns3_server)
 

docs/content/about/changelog.md

@@ -4,7 +4,8 @@
 
 **Added:**
 
-- `tox` for pipeline testing
+- `tox` for pipeline testing.
+- `projects_summary` and `templates_summary` methods for `Gns3Connector`.
 
 ## 0.2.0
 

docs/content/api_reference.md

@@ -66,6 +66,17 @@ def get_version(self)
 
 Returns the version information of GNS3 server
 
+### `Gns3Connector.projects_summary()`
+
+```python
+def projects_summary(self, is_print=True)
+```
+
+Returns a summary of the projects in the server. If `is_print` is `False`, it
+will return a list of tuples like:
+
+`[(name, project_id, total_nodes, total_links, status) ...]`
+
 ### `Gns3Connector.get_projects()`
 
 ```python
@@ -86,6 +97,17 @@ Retrieves a project from either a name or ID
 
 - `name` or `project_id`
 
+### `Gns3Connector.templates_summary()`
+
+```python
+def templates_summary(self, is_print=True)
+```
+
+Returns a summary of the templates in the server. If `is_print` is `False`, it
+will return a list of tuples like:
+
+`[(name, template_id, template_type, builtin, console_type, category) ...]`
+
 ### `Gns3Connector.get_templates()`
 
 ```python