readyview 0.0.3__tar.gz → 0.0.4__tar.gz

readyview-0.0.4/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: readyview
+Version: 0.0.4
+Summary: ReadyLinks ReadyView API library.
+Project-URL: Homepage, https://gitlab.com/readylinks
+Project-URL: Issues, https://gitlab.com/readylinks
+Author-email: ReadyLinks Developers <developers@ready-links.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# ReadyView Dashboard Python Library
+
+The ReadyView Dashboard Python library provides all current ReadyView [dashboard API](https://api.readylinks.io/redoc) calls to interface with the ReadyLinks ReadyView cloud-managed platform. ReadyView generates the library based on dashboard API's OpenAPI spec to keep it up to date with the latest API releases, and provides the full source code for the library including the tools used to generate the library. ReadyLinks welcomes constructive pull requests that maintain backwards compatibility with prior versions. The library requires Python 3.10+, receives support from the community, and you can install it via [PyPI](https://pypi.org/project/readyview/):
+
+```
+pip install --upgrdade readyview
+```
+
+## Usage
+1. Export your Organization ID and API Key as an environment variable, for example:
+```
+export READYVIEW_DASHBOARD_ORG_ID=YOUR_ORG_ID
+export READYVIEW_DASHBOARD_API_KEY=YOUR_API_KEY
+```
+2. Import the library with a single line at the top of your Python script.
+```
+import readyview
+```
+3. Instantiate the dashboard client. 
+```
+dashboard = readyview.Dashboard()
+```
+4. Start programmatically interacting with your ReadyView dashboard!
+```
+my_networks = dashboard.network.get_networks()
+```

readyview-0.0.4/README.md

@@ -0,0 +1,26 @@
+# ReadyView Dashboard Python Library
+
+The ReadyView Dashboard Python library provides all current ReadyView [dashboard API](https://api.readylinks.io/redoc) calls to interface with the ReadyLinks ReadyView cloud-managed platform. ReadyView generates the library based on dashboard API's OpenAPI spec to keep it up to date with the latest API releases, and provides the full source code for the library including the tools used to generate the library. ReadyLinks welcomes constructive pull requests that maintain backwards compatibility with prior versions. The library requires Python 3.10+, receives support from the community, and you can install it via [PyPI](https://pypi.org/project/readyview/):
+
+```
+pip install --upgrdade readyview
+```
+
+## Usage
+1. Export your Organization ID and API Key as an environment variable, for example:
+```
+export READYVIEW_DASHBOARD_ORG_ID=YOUR_ORG_ID
+export READYVIEW_DASHBOARD_API_KEY=YOUR_API_KEY
+```
+2. Import the library with a single line at the top of your Python script.
+```
+import readyview
+```
+3. Instantiate the dashboard client. 
+```
+dashboard = readyview.Dashboard()
+```
+4. Start programmatically interacting with your ReadyView dashboard!
+```
+my_networks = dashboard.network.get_networks()
+```

{readyview-0.0.3 → readyview-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "readyview"
-version = "0.0.3"
+version = "0.0.4"
 authors = [
   { name="ReadyLinks Developers", email="developers@ready-links.com" },
 ]

{readyview-0.0.3 → readyview-0.0.4}/src/readyview/dashboard.py

@@ -1,5 +1,6 @@
 from . import rest_session
 from .switch import Switch
+from .network import Network
 import os
 
 class Dashboard:
@@ -8,6 +9,7 @@ class Dashboard:
 		self.api_key = api_key or os.environ.get("READYVIEW_DASHBOARD_API_KEY")
 		self._rest = rest_session.RestSession(self.organization_id, self.api_key)
 		self.switch = Switch(self._rest)		
+		self.network = Network(self._rest)		
 
 	def display_info(self):
 		return (

readyview-0.0.4/src/readyview/network.py

@@ -0,0 +1,12 @@
+class Network(object): 
+	def __init__(self, rest):
+		super(Network, self).__init__()
+		self._rest = rest
+		
+	def get_networks(self):
+		url = f"v2/networks"
+		return self._rest.get(url)
+		
+	def get_network(self, id: str):
+		url = f"v2/networks/{id}"
+		return self._rest.get(url)

{readyview-0.0.3 → readyview-0.0.4}/src/readyview/switch.py

@@ -4,11 +4,11 @@ class Switch(object):
 		self._rest = rest
 		
 	def get_ports(self, mac_address: str):
-		url = f"v1/devices/{mac_address}/switch/ports"
+		url = f"v1/devices/{mac_address}/switch/ports/cache"
 		return self._rest.get(url)
 
 	def get_switch(self, mac_address: str):
-		url = f"v1/devices/{mac_address}/switch"
+		url = f"v1/devices/{mac_address}/switch/cache"
 		return self._rest.get(url)
 
 	def get_switches(self):

readyview-0.0.3/PKG-INFO

@@ -1,19 +0,0 @@
-Metadata-Version: 2.4
-Name: readyview
-Version: 0.0.3
-Summary: ReadyLinks ReadyView API library.
-Project-URL: Homepage, https://gitlab.com/readylinks
-Project-URL: Issues, https://gitlab.com/readylinks
-Author-email: ReadyLinks Developers <developers@ready-links.com>
-License-File: LICENSE
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-
-# Example Package
-
-This is a simple example package. You can use
-[GitHub-flavored Markdown](https://guides.github.com/features/mastering-markdown/)
-to write your content.

readyview-0.0.3/README.md

@@ -1,5 +0,0 @@
-# Example Package
-
-This is a simple example package. You can use
-[GitHub-flavored Markdown](https://guides.github.com/features/mastering-markdown/)
-to write your content.