Code cleanup

README.md

@@ -40,10 +40,10 @@ __Example Script (also some scripts in examples directory):__
 """ Example """
 
 import warnings
+
 import phpipamsdk
+from phpipamsdk.utils import get_section_id, get_subnet_id
 
-from phpipamsdk.utils import get_subnet_id
-from phpipamsdk.utils import get_section_id
 
 def list_subnets(ipam=None, section_name=None):
     """ get and print out section subnets """
@@ -55,7 +55,9 @@ def list_subnets(ipam=None, section_name=None):
 
     if 'data' in subnetlist:
         for item in subnetlist['data']:
-            print item['description'] + ": " + item['subnet'] + "/" + item['mask']
+            print('{}: {}/{}'.format(
+                item['description'], item['subnet'], item['mask']))
+
 
 def add_first_free_subnet(
         ipam=None, section_name=None, master_subnet_cidr=None, mask=None):
@@ -71,6 +73,7 @@ def add_first_free_subnet(
         subnet_id=master_subnet_id,
         mask=mask)
 
+
 if __name__ == "__main__":
     warnings.filterwarnings('ignore')
     IPAM = phpipamsdk.PhpIpamApi()
@@ -80,7 +83,7 @@ if __name__ == "__main__":
     add_first_free_subnet(
         ipam=IPAM, section_name='Customers',
         master_subnet_cidr="10.10.0.0/16", mask="24")
-    print '~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~'
+    print('~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~')
     list_subnets(ipam=IPAM, section_name='Customers')
 
     IPAM.logout()

phpipamsdk/__init__.py

@@ -2,26 +2,3 @@
 PhpIpam Api SDK
 Eric Donohue
 """
-
-from phpipamsdk.controllers import AddressesApi
-from phpipamsdk.controllers import CircuitsApi
-from phpipamsdk.controllers import DevicesApi
-from phpipamsdk.controllers import L2DomainsApi
-from phpipamsdk.controllers import PrefixesApi
-from phpipamsdk.controllers import SectionsApi
-from phpipamsdk.controllers import SubnetsApi
-from phpipamsdk.controllers import ToolsCustomersApi
-from phpipamsdk.controllers import ToolsDevicesApi
-from phpipamsdk.controllers import ToolsDeviceTypesApi
-from phpipamsdk.controllers import ToolsLocationsApi
-from phpipamsdk.controllers import ToolsNameserversApi
-from phpipamsdk.controllers import ToolsNATApi
-from phpipamsdk.controllers import ToolsRacksApi
-from phpipamsdk.controllers import ToolsScanagentsApi
-from phpipamsdk.controllers import ToolsTagsApi
-from phpipamsdk.controllers import ToolsVlansApi
-from phpipamsdk.controllers import ToolsVRFsApi
-from phpipamsdk.controllers import VlansApi
-from phpipamsdk.controllers import VRFsApi
-
-from phpipamsdk.phpipam import PhpIpamApi

phpipamsdk/controllers/__init__.py

@@ -1,22 +1 @@
 """ Controllers """
-
-from phpipamsdk.controllers.addresses_api import AddressesApi
-from phpipamsdk.controllers.circuits_api import CircuitsApi
-from phpipamsdk.controllers.devices_api import DevicesApi
-from phpipamsdk.controllers.l2domains_api import L2DomainsApi
-from phpipamsdk.controllers.prefixes_api import PrefixesApi
-from phpipamsdk.controllers.sections_api import SectionsApi
-from phpipamsdk.controllers.subnets_api import SubnetsApi
-from phpipamsdk.controllers.toolscustomers_api import ToolsCustomersApi
-from phpipamsdk.controllers.toolsdevices_api import ToolsDevicesApi
-from phpipamsdk.controllers.toolsdevicetypes_api import ToolsDeviceTypesApi
-from phpipamsdk.controllers.toolslocations_api import ToolsLocationsApi
-from phpipamsdk.controllers.toolsnameservers_api import ToolsNameserversApi
-from phpipamsdk.controllers.toolsnat_api import ToolsNATApi
-from phpipamsdk.controllers.toolsracks_api import ToolsRacksApi
-from phpipamsdk.controllers.toolsscanagents_api import ToolsScanagentsApi
-from phpipamsdk.controllers.toolstags_api import ToolsTagsApi
-from phpipamsdk.controllers.toolsvlans_api import ToolsVlansApi
-from phpipamsdk.controllers.toolsvrfs_api import ToolsVRFsApi
-from phpipamsdk.controllers.vlans_api import VlansApi
-from phpipamsdk.controllers.vrfs_api import VRFsApi

phpipamsdk/controllers/addresses_api.py

@@ -1,7 +1,6 @@
 """ Addresses Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class AddressesApi(object):

phpipamsdk/controllers/circuits_api.py

@@ -1,7 +1,6 @@
 """ Circuits Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class CircuitsApi(object):

phpipamsdk/controllers/devices_api.py

@@ -1,7 +1,6 @@
 """ Devices Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class DevicesApi(object):

phpipamsdk/controllers/l2domains_api.py

@@ -1,7 +1,6 @@
 """ L2Domains Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class L2DomainsApi(object):

phpipamsdk/controllers/prefixes_api.py

@@ -1,7 +1,6 @@
 """ Tools Prefixes Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class PrefixesApi(object):

phpipamsdk/controllers/sections_api.py

@@ -1,7 +1,6 @@
 """ Sections Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class SectionsApi(object):

phpipamsdk/controllers/subnets_api.py

@@ -1,7 +1,6 @@
 """ Subnets Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class SubnetsApi(object):

phpipamsdk/controllers/toolscustomers_api.py

@@ -1,7 +1,6 @@
 """ Tools Customers Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsCustomersApi(object):

phpipamsdk/controllers/toolsdevices_api.py

@@ -1,7 +1,6 @@
 """ Tools Devices Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsDevicesApi(object):

phpipamsdk/controllers/toolsdevicetypes_api.py

@@ -1,7 +1,6 @@
 """ Tools Device Types Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsDeviceTypesApi(object):

phpipamsdk/controllers/toolslocations_api.py

@@ -1,7 +1,6 @@
 """ Tools Locations Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsLocationsApi(object):

phpipamsdk/controllers/toolsnameservers_api.py

@@ -1,7 +1,6 @@
 """ Tools Nameservers Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsNameserversApi(object):

phpipamsdk/controllers/toolsnat_api.py

@@ -1,7 +1,6 @@
 """ Tools NAT Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsNATApi(object):

phpipamsdk/controllers/toolsracks_api.py

@@ -1,7 +1,6 @@
 """ Tools Racks Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsRacksApi(object):

phpipamsdk/controllers/toolsscanagents_api.py

@@ -1,7 +1,6 @@
 """ Tools Scanagents Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsScanagentsApi(object):

phpipamsdk/controllers/toolstags_api.py

@@ -1,7 +1,6 @@
 """ Tools Tags Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsTagsApi(object):

phpipamsdk/controllers/toolsvlans_api.py

@@ -1,7 +1,6 @@
 """ Tools Vlans Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsVlansApi(object):

phpipamsdk/controllers/toolsvrfs_api.py

@@ -1,7 +1,6 @@
 """ Tools VRFs Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class ToolsVRFsApi(object):

phpipamsdk/controllers/vlans_api.py

@@ -1,7 +1,6 @@
 """ Vlans Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class VlansApi(object):

phpipamsdk/controllers/vrfs_api.py

@@ -1,7 +1,6 @@
 """ VRFs Api Calls """
 
-from phpipamsdk.phpipam import PhpIpamApi
-from phpipamsdk.phpipam import build_payload
+from phpipamsdk.phpipam import PhpIpamApi, build_payload
 
 
 class VRFsApi(object):

phpipamsdk/phpipam.py

@@ -1,6 +1,7 @@
 """ Eric Donohue's PhpIPAM SDK """
 
 import json
+
 import requests
 
 from phpipamsdk.configuration import Configuration
@@ -9,7 +10,7 @@
 def build_payload(objmap=None, **kwargs):
     """ build the REST payload """
     payload = {}
-    for key, val in kwargs.items():
+    for key, val in list(kwargs.items()):
         if key in objmap:
             payload[objmap[key]] = val
     return payload

phpipamsdk/utils.py

@@ -1,15 +1,9 @@
 """ Utility Functions """
-from phpipamsdk.controllers import L2DomainsApi
-from phpipamsdk.controllers import SectionsApi
-from phpipamsdk.controllers import SubnetsApi
-from phpipamsdk.controllers import DevicesApi
-from phpipamsdk.controllers import ToolsDevicesApi
-from phpipamsdk.controllers import ToolsDeviceTypesApi
-from phpipamsdk.controllers import ToolsLocationsApi
-from phpipamsdk.controllers import ToolsRacksApi
-from phpipamsdk.controllers import ToolsTagsApi
-from phpipamsdk.controllers import VlansApi
-from phpipamsdk.controllers import VRFsApi
+from phpipamsdk.controllers import (DevicesApi, L2DomainsApi, SectionsApi,
+                                    SubnetsApi, ToolsDevicesApi,
+                                    ToolsDeviceTypesApi, ToolsLocationsApi,
+                                    ToolsRacksApi, ToolsTagsApi, VlansApi,
+                                    VRFsApi)
 
 
 def check_list(t_list='', t_item='', t_string=''):
@@ -69,6 +63,7 @@ def get_tools_device_id(ipam=None, name=None):
 
     return device[0]['id']
 
+
 def get_device_id(ipam=None, name=None):
     devices_api = DevicesApi(phpipam=ipam)
 
@@ -80,6 +75,7 @@ def get_device_id(ipam=None, name=None):
 
     return device[0]['id']
 
+
 def get_section_id(ipam=None, name=None):
     sections_api = SectionsApi(phpipam=ipam)
 

tox.ini

@@ -0,0 +1,26 @@
+[tox]
+envlist = py38, lint, isort
+skipsdist = True
+
+[flake8]
+exclude =
+    .git,
+    .venv,
+    .tox,
+    buildtools,
+    bin,
+    __pycache__,
+max-line-length = 80
+
+[testenv:lint]
+commands =
+    flake8 ./phpipamsdk
+deps =
+    flake8>=3.7.7,<4.0
+
+[testenv:isort]
+commands =
+    isort {posargs} --sd THIRDPARTY -p main -p audit -p sync ./phpipamsdk
+deps =
+    isort>5.0,<6.0
+