Merge pull request #3 from Bandwidth/SWI-5401

SWI-5401 Rename it to `bandwidth_numbers` from `iris_sdk`

Author: ajrice6713

README.md

@@ -2,7 +2,7 @@
 
 ## Needed tools
 
-    - Python 3.5
+    - Python >=3.7
     - pip
 
 ## Requires
@@ -11,30 +11,28 @@
     - requests
 
 ## Install
-```console
-pip install -e git+https://github.com/bandwidthcom/python-bandwidth-iris#egg=iris_sdk
+```sh
+pip install bandwidth-numbers-sdk
 ```
 
 ## Testing
 
 Tests require the *mock* and *requests_mock* packages. You can install them
 with
 
-```console
-pip install -r requirements.txt
+```sh
+pip install -r test-requirements.txt
 ```
 The tests can be run by issuing
-```console
-python -m unittest discover
+```sh
+pytest
 ```
 
 ## Usage
 
 ```python
-from iris_sdk import Account, Client
-```
+from bandwidth_numbers import Account, Client
 
-```python
 client = Client(url="https://dashboard.bandwidth.com/api", account_id=123456, username="foo",
     password="bar")
 ```
@@ -124,7 +122,7 @@ account.available_npa_nxx.list({"state": "NJ"})
 ### Cities
 
 ```python
-from iris_sdk import Cities
+from bandwidth_numbers import Cities
 
 cities = Cities(client=client)
 cities.list({"state": "NC"})
@@ -133,7 +131,7 @@ cities.list({"state": "NC"})
 ### Covered rate centers
 
 ```python
-from iris_sdk import CoveredRateCenters
+from bandwidth_numbers import CoveredRateCenters
 
 rate_centers = CoveredRateCenters(client=client)
 rate_centers.list({"page": 1, "size": 10})
@@ -421,7 +419,7 @@ portin.loas.metadata.delete()
 ### Rate Centers
 
 ```python
-from iris_sdk import RateCenters
+from bandwidth_numbers import RateCenters
 rc = RateCenters(client=client)
 centers = rc.list({"state": "CA", "available": "true"})
 ```
@@ -607,7 +605,7 @@ subscription.delete()
 #### Getting a phone number
 
 ```python
-from iris_sdk import Tns
+from bandwidth_numbers import Tns
 
 tns = Tns(client=client)
 tn = tns.get(id)

bandwidth_numbers/__init__.py

@@ -0,0 +1,11 @@
+from bandwidth_numbers.client import Client
+from bandwidth_numbers.models.account import Account
+from bandwidth_numbers.models.cities import Cities
+from bandwidth_numbers.models.covered_rate_centers import CoveredRateCenters
+from bandwidth_numbers.models.rate_centers import RateCenters
+from bandwidth_numbers.models.tns import Tns
+from bandwidth_numbers.models.users import Users
+from bandwidth_numbers.utils.rest import RestError
+
+__all__ = ["Client", "Account", "Tns", "Users", "Cities", "RateCenters",
+    "RestError", "CoveredRateCenters", ]

iris_sdk/client.py renamed to bandwidth_numbers/client.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
-from iris_sdk.utils.config import Config
-from iris_sdk.utils.rest import RestClient
+from bandwidth_numbers.utils.config import Config
+from bandwidth_numbers.utils.rest import RestClient
 
 class Client(object):
 

iris_sdk/include/__init__.py renamed to bandwidth_numbers/include/__init__.py

@@ -3,27 +3,27 @@
 from __future__ import division, absolute_import, print_function
 from future.builtins import super
 
-from iris_sdk.models.account_users import AccountUsers
-from iris_sdk.models.available_npa_nxx import AvailableNpaNxx
-from iris_sdk.models.available_numbers import AvailableNumbers
-from iris_sdk.models.base_resource import BaseResource
-from iris_sdk.models.data.account import AccountData
-from iris_sdk.models.disc_numbers import DiscNumbers
-from iris_sdk.models.disconnects import Disconnects
-from iris_sdk.models.in_service_numbers import InServiceNumbers
-from iris_sdk.models.line_option_orders import LineOptionOrder
-from iris_sdk.models.import_tn_checker import ImportTnChecker
-from iris_sdk.models.lnpchecker import LnpChecker
-from iris_sdk.models.orders import Orders
-from iris_sdk.models.lidbs import Lidbs
-from iris_sdk.models.dldas import Dldas
-from iris_sdk.models.subscriptions import Subscriptions
-from iris_sdk.models.portins import PortIns
-from iris_sdk.models.portouts import PortOuts
-from iris_sdk.models.reservation import Reservation
-from iris_sdk.models.site_hosts import SiteHosts
-from iris_sdk.models.sites import Sites
-from iris_sdk.models.tn_option_orders import TnOptionOrders
+from bandwidth_numbers.models.account_users import AccountUsers
+from bandwidth_numbers.models.available_npa_nxx import AvailableNpaNxx
+from bandwidth_numbers.models.available_numbers import AvailableNumbers
+from bandwidth_numbers.models.base_resource import BaseResource
+from bandwidth_numbers.models.data.account import AccountData
+from bandwidth_numbers.models.disc_numbers import DiscNumbers
+from bandwidth_numbers.models.disconnects import Disconnects
+from bandwidth_numbers.models.in_service_numbers import InServiceNumbers
+from bandwidth_numbers.models.line_option_orders import LineOptionOrder
+from bandwidth_numbers.models.import_tn_checker import ImportTnChecker
+from bandwidth_numbers.models.lnpchecker import LnpChecker
+from bandwidth_numbers.models.orders import Orders
+from bandwidth_numbers.models.lidbs import Lidbs
+from bandwidth_numbers.models.dldas import Dldas
+from bandwidth_numbers.models.subscriptions import Subscriptions
+from bandwidth_numbers.models.portins import PortIns
+from bandwidth_numbers.models.portouts import PortOuts
+from bandwidth_numbers.models.reservation import Reservation
+from bandwidth_numbers.models.site_hosts import SiteHosts
+from bandwidth_numbers.models.sites import Sites
+from bandwidth_numbers.models.tn_option_orders import TnOptionOrders
 
 XPATH_ACCOUNT = "/accounts/{}"
 

iris_sdk/include/xml_consts.py renamed to bandwidth_numbers/include/xml_consts.py

@@ -3,8 +3,8 @@
 from __future__ import division, absolute_import, print_function
 from future.builtins import super
 
-from iris_sdk.models.base_resource import BaseResource
-from iris_sdk.models.data.account_users import AccountUsersData
+from bandwidth_numbers.models.base_resource import BaseResource
+from bandwidth_numbers.models.data.account_users import AccountUsersData
 
 XML_NAME_USERS_ACC = "Users"
 XPATH_USERS_ACC = "/users"
@@ -21,4 +21,4 @@ def __init__(self, parent=None, client=None):
         AccountUsersData.__init__(self)
 
     def list(self):
-        return self._get_data().user
+        return self._get_data().user

iris_sdk/models/__init__.py renamed to bandwidth_numbers/models/__init__.py

@@ -3,8 +3,8 @@
 from __future__ import division, absolute_import, print_function
 from future.builtins import super
 
-from iris_sdk.models.base_resource import BaseResource
-from iris_sdk.models.data.activation_status import ActivationStatusData
+from bandwidth_numbers.models.base_resource import BaseResource
+from bandwidth_numbers.models.data.activation_status import ActivationStatusData
 
 XPATH_ACTIVATION_STATUS = "/activationStatus"
 
@@ -24,4 +24,4 @@ def get(self):
 
     def save(self):
         self.id = 1
-        self._save()
+        self._save()

iris_sdk/models/account.py renamed to bandwidth_numbers/models/account.py

@@ -3,8 +3,8 @@
 from __future__ import division, absolute_import, print_function
 from future.builtins import super
 
-from iris_sdk.models.base_resource import BaseResource
-from iris_sdk.models.data.available_npa_nxx import AvailableNpaNxxData
+from bandwidth_numbers.models.base_resource import BaseResource
+from bandwidth_numbers.models.data.available_npa_nxx import AvailableNpaNxxData
 
 XML_NAME_AVAILABLE_NPA_NXX = "SearchResultForAvailableNpaNxx"
 XPATH_AVAILABLE_NPA_NXX = "/availableNpaNxx"
@@ -22,4 +22,4 @@ def __init__(self, parent=None, client=None):
 
     def list(self, params):
         return self.get(params=params).available_npa_nxx_list.\
-            available_npa_nxx
+            available_npa_nxx