pyixapi 0.2.3__tar.gz → 0.2.5__tar.gz

{pyixapi-0.2.3 → pyixapi-0.2.5}/PKG-INFO

@@ -1,21 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pyixapi
-Version: 0.2.3
+Version: 0.2.5
 Summary: Python API client library for IX-API
 License: Apache-2.0
 Author: Guillaume Mazoyer
 Author-email: oss@mazoyer.eu
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: PyJWT (>=2.4.0,<2.9)
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: dev
+Requires-Dist: PyJWT (>=2.4.0,<2.11)
+Requires-Dist: pytest ; extra == "dev"
 Requires-Dist: requests (>=2.20.0,<3.0)
+Requires-Dist: ruff (>=0.9,<0.10) ; extra == "dev"
 Description-Content-Type: text/markdown
 
 # pyixapi

{pyixapi-0.2.3 → pyixapi-0.2.5}/pyixapi/core/api.py

@@ -29,7 +29,7 @@ from pyixapi.models import (
     RoleAssignment,
 )
 
-__version__ = "0.2.2"
+__version__ = "0.2.5"
 
 
 class API(object):
@@ -48,6 +48,7 @@ class API(object):
         access_token="",
         refresh_token="",
         user_agent=f"pyixapi/{__version__}",
+        proxies=None,
     ):
         self.url = url.rstrip("/")
         self.key = key
@@ -56,6 +57,7 @@ class API(object):
         self.refresh_token = Token.from_jwt(refresh_token) if refresh_token else None
         self.http_session = requests.Session()
         self.user_agent = user_agent
+        self.proxies = proxies
 
         self.auth = Endpoint(self, "auth")
         self.connections = Endpoint(self, "connections", model=Connection)
@@ -65,27 +67,17 @@ class API(object):
         self.facilities = Endpoint(self, "facilities", model=Facility)
         self.ips = Endpoint(self, "ips", model=IP)
         self.macs = Endpoint(self, "macs", model=MAC)
-        self.network_feature_configs = Endpoint(
-            self, "network-feature-configs", model=NetworkFeatureConfig
-        )
+        self.network_feature_configs = Endpoint(self, "network-feature-configs", model=NetworkFeatureConfig)
         self.network_features = Endpoint(self, "network-features", model=NetworkFeature)
-        self.network_service_configs = Endpoint(
-            self, "network-service-configs", model=NetworkServiceConfig
-        )
+        self.network_service_configs = Endpoint(self, "network-service-configs", model=NetworkServiceConfig)
         self.network_services = Endpoint(self, "network-services", model=NetworkService)
         self.pops = Endpoint(self, "pops", model=PoP)
         # Version 2+
-        self.member_joining_rules = Endpoint(
-            self, "member-joining-rules", model=MemberJoiningRule
-        )
+        self.member_joining_rules = Endpoint(self, "member-joining-rules", model=MemberJoiningRule)
         self.metro_areas = Endpoint(self, "metro-areas", model=MetroArea)
-        self.metro_area_networks = Endpoint(
-            self, "metro-area-networks", model=MetroAreaNetwork
-        )
+        self.metro_area_networks = Endpoint(self, "metro-area-networks", model=MetroAreaNetwork)
         self.ports = Endpoint(self, "ports", model=Port)
-        self.port_reservations = Endpoint(
-            self, "port-reservations", model=PortReservation
-        )
+        self.port_reservations = Endpoint(self, "port-reservations", model=PortReservation)
         self.roles = Endpoint(self, "roles", model=Role)
         self.role_assignments = Endpoint(self, "role-assignments", model=RoleAssignment)
 
@@ -95,14 +87,16 @@ class API(object):
         Get the API version of IX-API.
         """
         return Request(
-            base=self.url, token=self.access_token, http_session=self.http_session
+            base=self.url,
+            token=self.access_token,
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).get_version()
 
     @property
     def accounts(self):
-        return Endpoint(
-            self, "customers" if self.version == 1 else "accounts", model=Account
-        )
+        return Endpoint(self, "customers" if self.version == 1 else "accounts", model=Account)
 
     @property
     def product_offerings(self):
@@ -131,7 +125,10 @@ class API(object):
             return self.refresh_authentication()
 
         r = Request(
-            cat(self.url, "auth", "token"), http_session=self.http_session
+            cat(self.url, "auth", "token"),
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).post(data={"api_key": self.key, "api_secret": self.secret})
 
         self.access_token = Token.from_jwt(r["access_token"])
@@ -147,6 +144,8 @@ class API(object):
             cat(self.url, "auth", "refresh"),
             token=self.refresh_token.encoded,
             http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).post(data={"refresh_token": self.refresh_token.encoded})
 
         self.access_token = Token.from_jwt(r["access_token"])
@@ -164,5 +163,9 @@ class API(object):
             return {}
 
         return Request(
-            base=self.url, token=self.access_token, http_session=self.http_session
+            base=self.url,
+            token=self.access_token,
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).get_health()

{pyixapi-0.2.3 → pyixapi-0.2.5}/pyixapi/core/endpoint.py

@@ -28,6 +28,8 @@ class Endpoint(object):
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.api.user_agent,
+            proxies=self.api.proxies,
         )
         return RecordSet(self, r)
 
@@ -41,6 +43,8 @@ class Endpoint(object):
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.api.user_agent,
+            proxies=self.api.proxies,
         )
         return RecordSet(self, r)
 
@@ -74,6 +78,8 @@ class Endpoint(object):
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.api.user_agent,
+            proxies=self.api.proxies,
         )
         try:
             return next(RecordSet(self, r), None)
@@ -94,6 +100,8 @@ class Endpoint(object):
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.api.user_agent,
+            proxies=self.api.proxies,
         ).post(args[0] if args else kwargs)
 
         return self.return_obj(req, self.api, self)

{pyixapi-0.2.3 → pyixapi-0.2.5}/pyixapi/core/query.py

@@ -14,19 +14,13 @@ class RequestError(Exception):
         if r.status_code == 404:
             self.message = f"The requested url: {r.url} could not be found."
         elif r.status_code == 401:
-            self.message = (
-                "Authentication credentials are invalid, tokens renewal required."
-            )
+            self.message = "Authentication credentials are invalid, tokens renewal required."
         else:
             try:
-                self.message = (
-                    f"The request failed with code {r.status_code} "
-                    f"{r.reason}: {r.json()}"
-                )
+                self.message = f"The request failed with code {r.status_code} {r.reason}: {r.json()}"
             except ValueError:
                 self.message = (
-                    f"The request failed with code {r.status_code} "
-                    f"{r.reason} but details were not found as JSON."
+                    f"The request failed with code {r.status_code} {r.reason} but details were not found as JSON."
                 )
 
         super(RequestError, self).__init__(r)
@@ -48,9 +42,7 @@ class ContentError(Exception):
         super(ContentError, self).__init__(req)
 
         self.req = req
-        self.error = (
-            "The server returned invalid (non-JSON) data. Maybe not an IX-API server?"
-        )
+        self.error = "The server returned invalid (non-JSON) data. Maybe not an IX-API server?"
 
     def __str__(self):
         return self.error
@@ -70,7 +62,14 @@ class Request(object):
     """
 
     def __init__(
-        self, base, http_session, filters=None, key=None, token=None, user_agent=None
+        self,
+        base,
+        http_session,
+        filters=None,
+        key=None,
+        token=None,
+        user_agent=None,
+        proxies=None,
     ):
         self.base = base
         self.filters = filters or None
@@ -79,15 +78,14 @@ class Request(object):
         self.http_session = http_session
         self.url = self.base if not key else cat(self.base, key)
         self.user_agent = user_agent
+        self.proxies = proxies
 
     def get_openapi(self):
         """
         Get the OpenAPI Spec.
         """
         headers = {"Content-Type": "application/json;"}
-        req = self.http_session.get(
-            cat(self.base, "docs/?format=openapi"), headers=headers
-        )
+        req = self.http_session.get(cat(self.base, "docs/?format=openapi"), headers=headers)
         if req.ok:
             return req.json()
         else:
@@ -137,7 +135,12 @@ class Request(object):
                 params.update(add_params)
 
         r = getattr(self.http_session, verb)(
-            url_override or self.url, headers=headers, params=params, json=data
+            url_override or self.url,
+            headers=headers,
+            params=params,
+            json=data,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         )
 
         if verb == "delete":

{pyixapi-0.2.3 → pyixapi-0.2.5}/pyixapi/core/response.py

@@ -63,12 +63,8 @@ class RecordSet(object):
 
     def __next__(self):
         if self._response_cache:
-            return self.endpoint.return_obj(
-                self._response_cache.pop(), self.endpoint.api, self.endpoint
-            )
-        return self.endpoint.return_obj(
-            next(self.response), self.endpoint.api, self.endpoint
-        )
+            return self.endpoint.return_obj(self._response_cache.pop(), self.endpoint.api, self.endpoint)
+        return self.endpoint.return_obj(next(self.response), self.endpoint.api, self.endpoint)
 
     def __len__(self):
         try:
@@ -250,9 +246,7 @@ class Record(object):
             if isinstance(current_val, Record):
                 current_val = getattr(current_val, "serialize")(nested=True)
             if isinstance(current_val, list):
-                current_val = [
-                    v.id if isinstance(v, Record) else v for v in current_val
-                ]
+                current_val = [v.id if isinstance(v, Record) else v for v in current_val]
             r[i] = current_val
         return r
 
@@ -265,9 +259,7 @@ class Record(object):
             return k, v
 
         current = Hashabledict({fmt_dict(k, v) for k, v in self.serialize().items()})
-        init = Hashabledict(
-            {fmt_dict(k, v) for k, v in self.serialize(init=True).items()}
-        )
+        init = Hashabledict({fmt_dict(k, v) for k, v in self.serialize(init=True).items()})
         return set([i[0] for i in set(current.items()) ^ set(init.items())])
 
     def updates(self):
@@ -298,6 +290,8 @@ class Record(object):
                 base=self.endpoint.url,
                 token=self.api.access_token,
                 http_session=self.api.http_session,
+                user_agent=self.user_agent,
+                proxies=self.api.proxies,
             )
             if r.patch(updates):
                 return True
@@ -324,5 +318,7 @@ class Record(object):
             base=self.endpoint.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         return True if r.delete() else False

{pyixapi-0.2.3 → pyixapi-0.2.5}/pyixapi/core/util.py

@@ -1,9 +1,12 @@
+from typing import Any
+
+
 class Hashabledict(dict):
     def __hash__(self):
         return hash(frozenset(self))
 
 
-def cat(*args, separator="/", trailing=""):
+def cat(*args: Any, separator: str = "/", trailing: str = "") -> str:
     """
     Concatenate strings given a separator. All items will be parsed as string.
 

{pyixapi-0.2.3 → pyixapi-0.2.5}/pyproject.toml

@@ -1,47 +1,34 @@
-[tool.poetry]
+[project]
 name = "pyixapi"
-version = "0.2.3"
+version = "0.2.5"
 description = "Python API client library for IX-API"
-authors = ["Guillaume Mazoyer <oss@mazoyer.eu>"]
+authors = [{ name = "Guillaume Mazoyer", email = "oss@mazoyer.eu" }]
 readme = "README.md"
 license = "Apache-2.0"
-packages = [{ include = "pyixapi" }]
+requires-python = ">=3.9"
 classifiers = [
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
+dependencies = ["PyJWT>=2.4.0,<2.11", "requests>=2.20.0,<3.0"]
 
-[tool.poetry.dependencies]
-python = "^3.8"
-PyJWT = ">=2.4.0,<2.9"
-requests = ">=2.20.0,<3.0"
+[project.optional-dependencies]
+dev = ["pytest", "ruff>=0.9,<0.10"]
 
-[tool.poetry.group.dev.dependencies]
-pytest = "*"
-ruff = "~0.2"
+[tool.poetry]
+requires-poetry = ">=2.0"
+packages = [{ include = "pyixapi" }]
 
 [tool.ruff]
-line-length = 88
-
-exclude = [
-    ".git",
-    ".tox",
-    ".venv",
-    "env",
-    "_build",
-    "build",
-    "dist",
-    "examples",
-    "__main__.py",
-]
+line-length = 120
+exclude = [".git", ".tox", ".venv", "env", "_build", "build", "dist", "examples", "__main__.py"]
 
 [tool.ruff.lint]
-preview = true
-
 select = [
     "C90", # mccabe complexity
     "E",   # pycodestyle errors
@@ -67,12 +54,9 @@ line-ending = "auto"
 [tool.ruff.lint.isort]
 known-first-party = ["pyixapi"]
 
-[tool.ruff.lint.pycodestyle]
-max-line-length = 88
-
 [tool.ruff.lint.mccabe]
 max-complexity = 31
 
 [build-system]
-requires = ["poetry-core"]
+requires = ["poetry-core>=2.0"]
 build-backend = "poetry.core.masonry.api"