ipspot 0.1__py3-none-any.whl → 0.3__py3-none-any.whl

ipspot/__init__.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 """ipspot modules."""
 from .params import IPSPOT_VERSION, IPv4API
-from .functions import get_private_ipv4, get_public_ipv4
+from .ipv4 import get_private_ipv4, get_public_ipv4, is_ipv4
+from .utils import is_loopback
 __version__ = IPSPOT_VERSION

ipspot/__main__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """ipspot main."""
-from .functions import main
+from .cli import main
 
 
 if __name__ == "__main__":

ipspot/cli.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+"""ipspot CLI."""
+import argparse
+from typing import Union, Tuple
+from art import tprint
+from .ipv4 import get_public_ipv4, get_private_ipv4
+from .utils import filter_parameter
+from .params import IPv4API, PARAMETERS_NAME_MAP
+from .params import IPSPOT_OVERVIEW, IPSPOT_REPO, IPSPOT_VERSION
+
+
+def ipspot_info() -> None:  # pragma: no cover
+    """Print ipspot details."""
+    tprint("IPSpot")
+    tprint("V:" + IPSPOT_VERSION)
+    print(IPSPOT_OVERVIEW)
+    print("Repo : " + IPSPOT_REPO)
+
+
+def display_ip_info(ipv4_api: IPv4API = IPv4API.AUTO, geo: bool=False,
+                    timeout: Union[float, Tuple[float, float]]=5) -> None:  # pragma: no cover
+    """
+    Print collected IP and location data.
+
+    :param ipv4_api: public IPv4 API
+    :param geo: geolocation flag
+    :param timeout: timeout value for API
+    """
+    private_result = get_private_ipv4()
+    print("Private IP:\n")
+    print("  IP: {private_result[data][ip]}".format(private_result=private_result) if private_result["status"]
+          else "  Error: {private_result[error]}".format(private_result=private_result))
+
+    public_title = "\nPublic IP"
+    if geo:
+        public_title += " and Location Info"
+    public_title += ":\n"
+    print(public_title)
+    public_result = get_public_ipv4(ipv4_api, geo=geo, timeout=timeout)
+    if public_result["status"]:
+        for name, parameter in sorted(public_result["data"].items()):
+            print(
+                "  {name}: {parameter}".format(
+                    name=PARAMETERS_NAME_MAP[name],
+                    parameter=filter_parameter(parameter)))
+    else:
+        print("  Error: {public_result[error]}".format(public_result=public_result))
+
+
+def main() -> None:  # pragma: no cover
+    """CLI main function."""
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        '--ipv4-api',
+        help='public IPv4 API',
+        type=str.lower,
+        choices=[
+            x.value for x in IPv4API],
+        default=IPv4API.AUTO.value)
+    parser.add_argument('--info', help='info', nargs="?", const=1)
+    parser.add_argument('--version', help='version', nargs="?", const=1)
+    parser.add_argument('--no-geo', help='no geolocation data', nargs="?", const=1, default=False)
+    parser.add_argument('--timeout', help='timeout for the API request', type=float, default=5.0)
+
+    args = parser.parse_args()
+    if args.version:
+        print(IPSPOT_VERSION)
+    elif args.info:
+        ipspot_info()
+    else:
+        ipv4_api = IPv4API(args.ipv4_api)
+        geo = not args.no_geo
+        display_ip_info(ipv4_api=ipv4_api, geo=geo, timeout=args.timeout)

ipspot/ipv4.py

@@ -0,0 +1,273 @@
+# -*- coding: utf-8 -*-
+"""ipspot ipv4 functions."""
+import ipaddress
+import socket
+from typing import Union, Dict, List, Tuple
+import requests
+from requests.adapters import HTTPAdapter
+from urllib3.poolmanager import PoolManager
+from .utils import is_loopback
+from .params import REQUEST_HEADERS, IPv4API
+
+
+class IPv4HTTPAdapter(HTTPAdapter):
+    """A custom HTTPAdapter that enforces the use of IPv4 for DNS resolution during HTTP(S) requests using the requests library."""
+
+    def init_poolmanager(self, connections: int, maxsize: int, block: bool = False, **kwargs: dict) -> None:
+        """
+        Initialize the connection pool manager using a temporary override of socket.getaddrinfo to ensure only IPv4 addresses are used.
+
+        :param connections: the number of connection pools to cache
+        :param maxsize: the maximum number of connections to save in the pool
+        :param block: whether the connections should block when reaching the max size
+        :param kwargs: additional keyword arguments for the PoolManager
+        """
+        self.poolmanager = PoolManager(
+            num_pools=connections,
+            maxsize=maxsize,
+            block=block,
+            socket_options=self._ipv4_socket_options(),
+            **kwargs
+        )
+
+    def _ipv4_socket_options(self) -> list:
+        """
+        Temporarily patches socket.getaddrinfo to filter only IPv4 addresses (AF_INET).
+
+        :return: an empty list of socket options; DNS patching occurs here
+        """
+        original_getaddrinfo = socket.getaddrinfo
+
+        def ipv4_only_getaddrinfo(*args: list, **kwargs: dict) -> List[Tuple]:
+            results = original_getaddrinfo(*args, **kwargs)
+            return [res for res in results if res[0] == socket.AF_INET]
+
+        self._original_getaddrinfo = socket.getaddrinfo
+        socket.getaddrinfo = ipv4_only_getaddrinfo
+
+        return []
+
+    def __del__(self) -> None:
+        """Restores the original socket.getaddrinfo function upon adapter deletion."""
+        if hasattr(self, "_original_getaddrinfo"):
+            socket.getaddrinfo = self._original_getaddrinfo
+
+
+def is_ipv4(ip: str) -> bool:
+    """
+    Check if the given input is a valid IPv4 address.
+
+    :param ip: input IP
+    """
+    if not isinstance(ip, str):
+        return False
+    try:
+        _ = ipaddress.IPv4Address(ip)
+        return True
+    except Exception:
+        return False
+
+
+def get_private_ipv4() -> Dict[str, Union[bool, Dict[str, str], str]]:
+    """Retrieve the private IPv4 address."""
+    try:
+        with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s:
+            s.connect(('192.168.1.1', 1))
+            private_ip = s.getsockname()[0]
+        if is_ipv4(private_ip) and not is_loopback(private_ip):
+            return {"status": True, "data": {"ip": private_ip}}
+        return {"status": False, "error": "Could not identify a non-loopback IPv4 address for this system."}
+    except Exception as e:
+        return {"status": False, "error": str(e)}
+
+
+def _ipsb_ipv4(geo: bool=False, timeout: Union[float, Tuple[float, float]]
+               =5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
+    """
+    Get public IP and geolocation using ip.sb.
+
+    :param geo: geolocation flag
+    :param timeout: timeout value for API
+    """
+    try:
+        with requests.Session() as session:
+            response = session.get("https://api-ipv4.ip.sb/geoip", headers=REQUEST_HEADERS, timeout=timeout)
+            response.raise_for_status()
+            data = response.json()
+            result = {"status": True, "data": {"ip": data.get("ip"), "api": "ip.sb"}}
+            if geo:
+                geo_data = {
+                    "city": data.get("city"),
+                    "region": data.get("region"),
+                    "country": data.get("country"),
+                    "country_code": data.get("country_code"),
+                    "latitude": data.get("latitude"),
+                    "longitude": data.get("longitude"),
+                    "organization": data.get("organization"),
+                    "timezone": data.get("timezone")
+                }
+                result["data"].update(geo_data)
+            return result
+    except Exception as e:
+        return {"status": False, "error": str(e)}
+
+
+def _ipapi_ipv4(geo: bool=False, timeout: Union[float, Tuple[float, float]]
+                =5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
+    """
+    Get public IP and geolocation using ip-api.com.
+
+    :param geo: geolocation flag
+    :param timeout: timeout value for API
+    """
+    try:
+        with requests.Session() as session:
+            session.mount("http://", IPv4HTTPAdapter())
+            session.mount("https://", IPv4HTTPAdapter())
+            response = session.get("http://ip-api.com/json/", headers=REQUEST_HEADERS, timeout=timeout)
+            response.raise_for_status()
+            data = response.json()
+            if data.get("status") != "success":
+                return {"status": False, "error": "ip-api lookup failed"}
+            result = {"status": True, "data": {"ip": data.get("query"), "api": "ip-api.com"}}
+            if geo:
+                geo_data = {
+                    "city": data.get("city"),
+                    "region": data.get("regionName"),
+                    "country": data.get("country"),
+                    "country_code": data.get("countryCode"),
+                    "latitude": data.get("lat"),
+                    "longitude": data.get("lon"),
+                    "organization": data.get("org"),
+                    "timezone": data.get("timezone")
+                }
+                result["data"].update(geo_data)
+            return result
+    except Exception as e:
+        return {"status": False, "error": str(e)}
+
+
+def _ipinfo_ipv4(geo: bool=False, timeout: Union[float, Tuple[float, float]]
+                 =5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
+    """
+    Get public IP and geolocation using ipinfo.io.
+
+    :param geo: geolocation flag
+    :param timeout: timeout value for API
+    """
+    try:
+        with requests.Session() as session:
+            session.mount("http://", IPv4HTTPAdapter())
+            session.mount("https://", IPv4HTTPAdapter())
+            response = session.get("https://ipinfo.io/json", headers=REQUEST_HEADERS, timeout=timeout)
+            response.raise_for_status()
+            data = response.json()
+            result = {"status": True, "data": {"ip": data.get("ip"), "api": "ipinfo.io"}}
+            if geo:
+                loc = data.get("loc", "").split(",")
+                geo_data = {
+                    "city": data.get("city"),
+                    "region": data.get("region"),
+                    "country": None,
+                    "country_code": data.get("country"),
+                    "latitude": float(loc[0]) if len(loc) == 2 else None,
+                    "longitude": float(loc[1]) if len(loc) == 2 else None,
+                    "organization": data.get("org"),
+                    "timezone": data.get("timezone")
+                }
+                result["data"].update(geo_data)
+            return result
+    except Exception as e:
+        return {"status": False, "error": str(e)}
+
+
+def _ident_me_ipv4(geo: bool=False, timeout: Union[float, Tuple[float, float]]
+                   =5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
+    """
+    Get public IP and geolocation using ident.me.
+
+    :param geo: geolocation flag
+    :param timeout: timeout value for API
+    """
+    try:
+        with requests.Session() as session:
+            response = session.get("https://4.ident.me/json", headers=REQUEST_HEADERS, timeout=timeout)
+            response.raise_for_status()
+            data = response.json()
+            result = {"status": True, "data": {"ip": data.get("ip"), "api": "ident.me"}}
+            if geo:
+                geo_data = {
+                    "city": data.get("city"),
+                    "region": None,
+                    "country": data.get("country"),
+                    "country_code": data.get("cc"),
+                    "latitude": data.get("latitude"),
+                    "longitude": data.get("longitude"),
+                    "organization": data.get("aso"),
+                    "timezone": data.get("tz")
+                }
+                result["data"].update(geo_data)
+            return result
+    except Exception as e:
+        return {"status": False, "error": str(e)}
+
+
+def _tnedime_ipv4(geo: bool=False, timeout: Union[float, Tuple[float, float]]
+                  =5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
+    """
+    Get public IP and geolocation using tnedi.me.
+
+    :param geo: geolocation flag
+    :param timeout: timeout value for API
+    """
+    try:
+        with requests.Session() as session:
+            response = session.get("https://4.tnedi.me/json", headers=REQUEST_HEADERS, timeout=timeout)
+            response.raise_for_status()
+            data = response.json()
+            result = {"status": True, "data": {"ip": data.get("ip"), "api": "tnedi.me"}}
+            if geo:
+                geo_data = {
+                    "city": data.get("city"),
+                    "region": None,
+                    "country": data.get("country"),
+                    "country_code": data.get("cc"),
+                    "latitude": data.get("latitude"),
+                    "longitude": data.get("longitude"),
+                    "organization": data.get("aso"),
+                    "timezone": data.get("tz")
+                }
+                result["data"].update(geo_data)
+            return result
+    except Exception as e:
+        return {"status": False, "error": str(e)}
+
+
+def get_public_ipv4(api: IPv4API=IPv4API.AUTO, geo: bool=False,
+                    timeout: Union[float, Tuple[float, float]]=5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
+    """
+    Get public IPv4 and geolocation info based on the selected API.
+
+    :param api: public IPv4 API
+    :param geo: geolocation flag
+    :param timeout: timeout value for API
+    """
+    api_map = {
+        IPv4API.IDENTME: _ident_me_ipv4,
+        IPv4API.TNEDIME: _tnedime_ipv4,
+        IPv4API.IPSB: _ipsb_ipv4,
+        IPv4API.IPAPI: _ipapi_ipv4,
+        IPv4API.IPINFO: _ipinfo_ipv4,
+    }
+
+    if api == IPv4API.AUTO:
+        for _, func in api_map.items():
+            result = func(geo=geo, timeout=timeout)
+            if result["status"]:
+                return result
+        return {"status": False, "error": "All attempts failed."}
+    else:
+        func = api_map.get(api)
+        if func:
+            return func(geo=geo, timeout=timeout)
+        return {"status": False, "error": "Unsupported API: {api}".format(api=api)}

ipspot/params.py

@@ -2,7 +2,7 @@
 """ipspot params."""
 from enum import Enum
 
-IPSPOT_VERSION = "0.1"
+IPSPOT_VERSION = "0.3"
 
 IPSPOT_OVERVIEW = '''
 IPSpot is a Python library for retrieving the current system's IP address and location information.
@@ -10,7 +10,12 @@ It currently supports public and private IPv4 detection using multiple API provi
 Designed with simplicity and modularity in mind, IPSpot offers quick IP and geolocation lookups directly from your machine.
 '''
 
-IPSPOT_REPO = "Repo : https://github.com/openscilab/ipspot"
+IPSPOT_REPO = "https://github.com/openscilab/ipspot"
+
+REQUEST_HEADERS = {
+    'User-Agent': 'IPSpot/{version} ({repo})'.format(version=IPSPOT_VERSION, repo=IPSPOT_REPO),
+    'Accept': 'application/json'
+}
 
 
 class IPv4API(Enum):
@@ -19,6 +24,9 @@ class IPv4API(Enum):
     AUTO = "auto"
     IPAPI = "ipapi"
     IPINFO = "ipinfo"
+    IPSB = "ipsb"
+    IDENTME = "identme"
+    TNEDIME = "tnedime"
 
 
 PARAMETERS_NAME_MAP = {

ipspot/utils.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+"""ipspot utils."""
+import ipaddress
+from typing import Any
+
+
+def is_loopback(ip: str) -> bool:
+    """
+    Check if the given input IP is a loopback address.
+
+    :param ip: input IP
+    """
+    try:
+        ip_object = ipaddress.ip_address(ip)
+        return ip_object.is_loopback
+    except Exception:
+        return False
+
+
+def filter_parameter(parameter: Any) -> Any:
+    """
+    Filter input parameter.
+
+    :param parameter: input parameter
+    """
+    if parameter is None:
+        return "N/A"
+    if isinstance(parameter, str) and len(parameter.strip()) == 0:
+        return "N/A"
+    return parameter

{ipspot-0.1.dist-info → ipspot-0.3.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: ipspot
-Version: 0.1
+Version: 0.3
 Summary: IPSpot: A Python Tool to Fetch the System's IP Address
 Home-page: https://github.com/openscilab/ipspot
-Download-URL: https://github.com/openscilab/ipspot/tarball/v0.1
+Download-URL: https://github.com/openscilab/ipspot/tarball/v0.3
 Author: IPSpot Development Team
 Author-email: ipspot@openscilab.com
 License: MIT
@@ -55,6 +55,7 @@ Dynamic: summary
 <a href="https://badge.fury.io/py/ipspot"><img src="https://badge.fury.io/py/ipspot.svg" alt="PyPI version"></a>
 <a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
 <a href="https://github.com/openscilab/ipspot"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/openscilab/ipspot"></a>
+<a href="https://discord.gg/yyDV3T4cwU"><img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel"></a>
 </div>			
 				
 ## Overview	
@@ -89,17 +90,25 @@ Dynamic: summary
 	</tr>
 </table>
 
+<table>
+	<tr> 
+		<td align="center">Code Quality</td>
+		<td align="center"><a href="https://app.codacy.com/gh/openscilab/ipspot/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/cb2ab6584eb443b8a33da4d4252480bc"/></a></td>
+		<td align="center"><a href="https://www.codefactor.io/repository/github/openscilab/ipspot"><img src="https://www.codefactor.io/repository/github/openscilab/ipspot/badge" alt="CodeFactor"></a></td>
+	</tr>
+</table>
+
 
 ## Installation		
 
 ### Source Code
-- Download [Version 0.1](https://github.com/openscilab/ipspot/archive/v0.1.zip) or [Latest Source](https://github.com/openscilab/ipspot/archive/dev.zip)
+- Download [Version 0.3](https://github.com/openscilab/ipspot/archive/v0.3.zip) or [Latest Source](https://github.com/openscilab/ipspot/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install ipspot==0.1`						
+- `pip install ipspot==0.3`						
 
 
 ## Usage
@@ -112,7 +121,7 @@ Dynamic: summary
 >>> from ipspot import get_public_ipv4, IPv4API
 >>> get_public_ipv4(api=IPv4API.IPAPI)
 {'status': True, 'data': {'ip': 'xx.xx.xx.xx', 'api': 'ip-api.com'}}
->>> get_public_ipv4(api=IPv4API.IPAPI, geo=True)
+>>> get_public_ipv4(api=IPv4API.IPAPI, geo=True, timeout=10)
 {'data': {'country_code': 'GB', 'latitude': 50.9097, 'longitude': -1.4043, 'api': 'ip-api.com', 'country': 'United Kingdom', 'timezone': 'Europe/London', 'organization': '', 'region': 'England', 'ip': 'xx.xx.xx.xx', 'city': 'Southampton'}, 'status': True}
 ```
 
@@ -133,7 +142,7 @@ Dynamic: summary
 ```console
 > ipspot --version
 
-0.1
+0.3
 ```
 
 #### Info
@@ -148,11 +157,11 @@ Dynamic: summary
 |___||_|    |____/ | .__/  \___/  \__|
                    |_|
 
-__     __     ___      _
-\ \   / / _  / _ \    / |
- \ \ / / (_)| | | |   | |
-  \ V /   _ | |_| | _ | |
-   \_/   (_) \___/ (_)|_|
+__     __     ___      _____
+\ \   / / _  / _ \    |___ /
+ \ \ / / (_)| | | |     |_ \
+  \ V /   _ | |_| | _  ___) |
+   \_/   (_) \___/ (_)|____/
 
 
 
@@ -188,7 +197,7 @@ Public IP and Location Info:
 
 #### IPv4 API
 
-ℹ️ `ipv4-api` valid choices: [`auto`, `ipapi`, `ipinfo`]
+ℹ️ `ipv4-api` valid choices: [`auto`, `ipapi`, `ipinfo`, `ipsb`, `identme`, `tnedime`]
 
 ℹ️ The default value: `auto`
 
@@ -231,7 +240,12 @@ Public IP:
 Just fill an issue and describe it. We'll check it ASAP!
 
 - Please complete the issue template
- 			
+
+You can also join our discord server
+
+<a href="https://discord.gg/yyDV3T4cwU">
+  <img src="https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge" alt="Discord Channel">
+</a>
 
 ## Show Your Support
 								
@@ -253,6 +267,31 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.3] - 2025-05-19
+### Added
+- `is_ipv4` function
+- `is_loopback` function
+- `IPv4HTTPAdapter` class
+- Support [ident.me](https://ident.me/json)
+- Support [tnedi.me](https://tnedi.me/json)
+### Changed
+- `get_private_ipv4` function modified
+- `get_public_ipv4` function modified
+- `_ipsb_ipv4` function modified
+- `_ipapi_ipv4` function modified
+- `_ipinfo_ipv4` function modified
+- `functions.py` renamed to `utils.py` 
+- CLI functions moved to `cli.py`
+- IPv4 functions moved to `ipv4.py`
+- Test system modified
+## [0.2] - 2025-05-04
+### Added
+- Support [ip.sb](https://api.ip.sb/geoip)
+- `--timeout` argument
+### Changed
+- `README.md` updated
+- Requests header updated
+- Test system modified
 ## [0.1] - 2025-04-25
 ### Added
 - Support [ipinfo.io](https://ipinfo.io)
@@ -264,7 +303,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `--no-geo` argument
 - Logo
 
-[Unreleased]: https://github.com/openscilab/ipspot/compare/v0.1...dev
+[Unreleased]: https://github.com/openscilab/ipspot/compare/v0.3...dev
+[0.3]: https://github.com/openscilab/ipspot/compare/v0.2...v0.3
+[0.2]: https://github.com/openscilab/ipspot/compare/v0.1...v0.2
 [0.1]: https://github.com/openscilab/ipspot/compare/3216fb7...v0.1
 
 

ipspot-0.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+ipspot/__init__.py,sha256=e_1FqqNDD9eoDVw9eKL_1pS7du-Sei3lm6A4UFjYiUo,211
+ipspot/__main__.py,sha256=xKHY_tc94SWktkIHV0O9YADAHPZvT8yXOFSm_L2yMno,105
+ipspot/cli.py,sha256=Yq0GVzyZhMUauTMA_BUO8UXa6OqfYDBLLVjERZ3vOgE,2632
+ipspot/ipv4.py,sha256=OhQQnRdkwQ-SrfaqJdhF1Qu_zsW-mi93NEk_N5QAOrk,10757
+ipspot/params.py,sha256=EekA1HmFlxRT-wk0mEKHvPSR_O6UTHWSBgQoiC5-aRU,1147
+ipspot/utils.py,sha256=OaRrNQI8ASUHisMVEhyfy4lwcgugRxXK4JcWqljITfE,636
+ipspot-0.3.dist-info/licenses/AUTHORS.md,sha256=AgFL2paPd70ItL_YK18lWm_NjNWytKZHmR57o-et8kU,236
+ipspot-0.3.dist-info/licenses/LICENSE,sha256=0aOd4wzZRoSH_35UZXRHS7alPFTtuFEBJrajLuonEIw,1067
+ipspot-0.3.dist-info/METADATA,sha256=h2XSvM65GkEAL8COdzOpbuOtiQSj3fEgdYCfON6ZCeA,9400
+ipspot-0.3.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+ipspot-0.3.dist-info/entry_points.txt,sha256=DJVLepYr8H3UcvWekU5Jy-tcr_xmWrphzgWGNOd3hlk,43
+ipspot-0.3.dist-info/top_level.txt,sha256=v0WgE1z2iCy_bXU53fVcllwHLTvGNBIvq8u3KPC2_Sc,7
+ipspot-0.3.dist-info/RECORD,,

{ipspot-0.1.dist-info → ipspot-0.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.1)
+Generator: setuptools (80.7.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ipspot-0.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ipspot = ipspot.cli:main

ipspot/functions.py

@@ -1,179 +0,0 @@
-# -*- coding: utf-8 -*-
-"""ipspot functions."""
-import argparse
-import socket
-from typing import Union, Dict, Any
-import requests
-from art import tprint
-from .params import IPv4API, PARAMETERS_NAME_MAP
-from .params import IPSPOT_OVERVIEW, IPSPOT_REPO, IPSPOT_VERSION
-
-
-def ipspot_info() -> None:
-    """Print ipspot details."""
-    tprint("IPSpot")
-    tprint("V:" + IPSPOT_VERSION)
-    print(IPSPOT_OVERVIEW)
-    print(IPSPOT_REPO)
-
-
-def get_private_ipv4() -> Dict[str, Union[bool, Dict[str, str], str]]:
-    """Retrieve the private IPv4 address."""
-    try:
-        hostname = socket.gethostname()
-        private_ip = socket.gethostbyname(hostname)
-        return {"status": True, "data": {"ip": private_ip}}
-    except Exception as e:
-        return {"status": False, "error": str(e)}
-
-
-def _ipapi_ipv4(geo: bool=False) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
-    """
-    Get public IP and geolocation using ip-api.com.
-
-    :param geo: geolocation flag
-    """
-    try:
-        response = requests.get("http://ip-api.com/json/", timeout=5)
-        response.raise_for_status()
-        data = response.json()
-
-        if data.get("status") != "success":
-            return {"status": False, "error": "ip-api lookup failed"}
-        result = {"status": True, "data": {"ip": data.get("query"), "api": "ip-api.com"}}
-        if geo:
-            geo_data = {
-                "city": data.get("city"),
-                "region": data.get("regionName"),
-                "country": data.get("country"),
-                "country_code": data.get("countryCode"),
-                "latitude": data.get("lat"),
-                "longitude": data.get("lon"),
-                "organization": data.get("org"),
-                "timezone": data.get("timezone")
-            }
-            result["data"].update(geo_data)
-        return result
-    except Exception as e:
-        return {"status": False, "error": str(e)}
-
-
-def _ipinfo_ipv4(geo: bool=False) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
-    """
-    Get public IP and geolocation using ipinfo.io.
-
-    :param geo: geolocation flag
-    """
-    try:
-        response = requests.get("https://ipinfo.io/json", timeout=5)
-        response.raise_for_status()
-        data = response.json()
-        result = {"status": True, "data": {"ip": data.get("ip"), "api": "ipinfo.io"}}
-        if geo:
-            loc = data.get("loc", "").split(",")
-            geo_data = {
-                "city": data.get("city"),
-                "region": data.get("region"),
-                "country": None,
-                "country_code": data.get("country"),
-                "latitude": float(loc[0]) if len(loc) == 2 else None,
-                "longitude": float(loc[1]) if len(loc) == 2 else None,
-                "organization": data.get("org"),
-                "timezone": data.get("timezone")
-            }
-            result["data"].update(geo_data)
-        return result
-    except Exception as e:
-        return {"status": False, "error": str(e)}
-
-
-def get_public_ipv4(api: IPv4API=IPv4API.AUTO,
-                    geo: bool=False) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
-    """
-    Get public IPv4 and geolocation info based on the selected API.
-
-    :param api: public IPv4 API
-    :param geo: geolocation flag
-    """
-    api_map = {
-        IPv4API.IPAPI: _ipapi_ipv4,
-        IPv4API.IPINFO: _ipinfo_ipv4,
-    }
-
-    if api == IPv4API.AUTO:
-        for _, func in api_map.items():
-            result = func(geo=geo)
-            if result["status"]:
-                return result
-        return {"status": False, "error": "All attempts failed."}
-    else:
-        func = api_map.get(api)
-        if func:
-            return func(geo=geo)
-        return {"status": False, "error": "Unsupported API: {api}".format(api=api)}
-
-
-def filter_parameter(parameter: Any) -> Any:
-    """
-    Filter input parameter.
-
-    :param parameter: input parameter
-    """
-    if parameter is None:
-        return "N/A"
-    if isinstance(parameter, str) and len(parameter.strip()) == 0:
-        return "N/A"
-    return parameter
-
-
-def display_ip_info(ipv4_api: IPv4API = IPv4API.AUTO, geo: bool=False) -> None:
-    """
-    Print collected IP and location data.
-
-    :param ipv4_api: public IPv4 API
-    :param geo: geolocation flag
-    """
-    private_result = get_private_ipv4()
-    print("Private IP:\n")
-    print("  IP: {private_result[data][ip]}".format(private_result=private_result) if private_result["status"]
-          else "  Error: {private_result[error]}".format(private_result=private_result))
-
-    public_title = "\nPublic IP"
-    if geo:
-        public_title += " and Location Info"
-    public_title += ":\n"
-    print(public_title)
-    public_result = get_public_ipv4(ipv4_api, geo=geo)
-    if public_result["status"]:
-        for name, parameter in sorted(public_result["data"].items()):
-            print(
-                "  {name}: {parameter}".format(
-                    name=PARAMETERS_NAME_MAP[name],
-                    parameter=filter_parameter(parameter)))
-    else:
-        print("  Error: {public_result[error]}".format(public_result=public_result))
-
-
-def main() -> None:
-    """CLI main function."""
-    parser = argparse.ArgumentParser()
-    parser.add_argument(
-        '--ipv4-api',
-        help='public IPv4 API',
-        type=str.lower,
-        choices=[
-            x.value for x in IPv4API],
-        default=IPv4API.AUTO.value)
-    parser.add_argument('--info', help='info', nargs="?", const=1)
-    parser.add_argument('--version', help='version', nargs="?", const=1)
-    parser.add_argument('--no-geo', help='no geolocation data', nargs="?", const=1, default=False)
-
-    args = parser.parse_args()
-    if args.version:
-        print(IPSPOT_VERSION)
-    elif args.info:
-        ipspot_info()
-    else:
-        ipv4_api = IPv4API(args.ipv4_api)
-        geo = not args.no_geo
-        display_ip_info(ipv4_api=ipv4_api, geo=geo)

ipspot-0.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-ipspot/__init__.py,sha256=cxty-JGyo_sLeQd7bHrXUoEabl3QhLtgA9UtLcStp6o,176
-ipspot/__main__.py,sha256=17x2Q5vGORstO8mZ8B9aDixcOK5Gl71Ej5fC5P1EBKY,111
-ipspot/functions.py,sha256=rXSoVRGDCDeH4anda8_o3rgE0jl5VqvfoDA-DL_bnDo,5936
-ipspot/params.py,sha256=J-O4-qaRLQCAVc9a0yKJpFC0LCOG1SvsHBgjA-T59pY,936
-ipspot-0.1.dist-info/licenses/AUTHORS.md,sha256=AgFL2paPd70ItL_YK18lWm_NjNWytKZHmR57o-et8kU,236
-ipspot-0.1.dist-info/licenses/LICENSE,sha256=0aOd4wzZRoSH_35UZXRHS7alPFTtuFEBJrajLuonEIw,1067
-ipspot-0.1.dist-info/METADATA,sha256=qtGhxEFLspKwu1qFF3IOE157RImRrlOroU2fbBdz7zs,7667
-ipspot-0.1.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-ipspot-0.1.dist-info/entry_points.txt,sha256=SYgm9eGlJY7AGqi4_PmFVXwjEoylPPnAHeAeJPtYdjk,49
-ipspot-0.1.dist-info/top_level.txt,sha256=v0WgE1z2iCy_bXU53fVcllwHLTvGNBIvq8u3KPC2_Sc,7
-ipspot-0.1.dist-info/RECORD,,

ipspot-0.1.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-ipspot = ipspot.functions:main