ipspot 0.3__tar.gz → 0.4__tar.gz

{ipspot-0.3 → ipspot-0.4}/AUTHORS.md

@@ -1,6 +1,8 @@
 # Core Developers
 ----------
 - Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi)) **
+- Sadra Sabouri - Open Science Laboratory ([Github](https://github.com/sadrasabouri))
+- AmirHosein Rostami  - Open Science Laboratory ([Github](https://github.com/AHReccese))
 
 ** **Maintainer**
 

{ipspot-0.3 → ipspot-0.4}/CHANGELOG.md

@@ -5,6 +5,29 @@ 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.4] - 2025-06-09
+### Added
+- Support [ipapi.co](https://ipapi.co/json/)
+- Support [ipleak.net](https://ipleak.net/json/)
+- Support [my-ip.io](https://www.my-ip.io/)
+- Support [ifconfig.co](https://ifconfig.co/json)
+- Support [reallyfreegeoip.org](https://reallyfreegeoip.org/json/)
+- Support [myip.la](https://api.myip.la/en?json)
+- Support [freeipapi.com](https://freeipapi.com/api/json/)
+- `AUTO_SAFE` mode
+- `_get_json_standard` function
+- `_get_json_ipv4_forced` function
+- `--max-retries` argument
+- `--retry-delay` argument
+### Changed
+- `IPv4API.IPAPI` renamed to `IPv4API.IP_API_COM`
+- `IPv4API.IPINFO` renamed to `IPv4API.IPINFO_IO`
+- `IPv4API.IPSB` renamed to `IPv4API.IP_SB`
+- `IPv4API.IDENTME` renamed to `IPv4API.IDENT_ME`
+- `IPv4API.TNEDIME` renamed to `IPv4API.TNEDI_ME`
+- `get_public_ipv4` function modified
+- `filter_parameter` function renamed to `_filter_parameter`
+- `README.md` updated
 ## [0.3] - 2025-05-19
 ### Added
 - `is_ipv4` function
@@ -41,7 +64,8 @@ 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.3...dev
+[Unreleased]: https://github.com/openscilab/ipspot/compare/v0.4...dev
+[0.4]: https://github.com/openscilab/ipspot/compare/v0.3...v0.4
 [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 → ipspot-0.4}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: ipspot
-Version: 0.3
+Version: 0.4
 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.3
+Download-URL: https://github.com/openscilab/ipspot/tarball/v0.4
 Author: IPSpot Development Team
 Author-email: ipspot@openscilab.com
 License: MIT
@@ -102,13 +102,13 @@ Dynamic: summary
 ## Installation		
 
 ### Source Code
-- Download [Version 0.3](https://github.com/openscilab/ipspot/archive/v0.3.zip) or [Latest Source](https://github.com/openscilab/ipspot/archive/dev.zip)
+- Download [Version 0.4](https://github.com/openscilab/ipspot/archive/v0.4.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.3`						
+- `pip install ipspot==0.4`						
 
 
 ## Usage
@@ -119,9 +119,11 @@ Dynamic: summary
 
 ```pycon
 >>> from ipspot import get_public_ipv4, IPv4API
->>> get_public_ipv4(api=IPv4API.IPAPI)
+>>> get_public_ipv4(api=IPv4API.IP_API_COM)
 {'status': True, 'data': {'ip': 'xx.xx.xx.xx', 'api': 'ip-api.com'}}
->>> get_public_ipv4(api=IPv4API.IPAPI, geo=True, timeout=10)
+>>> get_public_ipv4(api=IPv4API.IP_API_COM, 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}
+>>> get_public_ipv4(api=IPv4API.IP_API_COM, geo=True, timeout=10, max_retries=5, retry_delay=4)
 {'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}
 ```
 
@@ -142,7 +144,7 @@ Dynamic: summary
 ```console
 > ipspot --version
 
-0.3
+0.4
 ```
 
 #### Info
@@ -157,11 +159,11 @@ Dynamic: summary
 |___||_|    |____/ | .__/  \___/  \__|
                    |_|
 
-__     __     ___      _____
-\ \   / / _  / _ \    |___ /
- \ \ / / (_)| | | |     |_ \
-  \ V /   _ | |_| | _  ___) |
-   \_/   (_) \___/ (_)|____/
+__     __     ___      _  _
+\ \   / / _  / _ \    | || |
+ \ \ / / (_)| | | |   | || |_
+  \ V /   _ | |_| | _ |__   _|
+   \_/   (_) \___/ (_)   |_|
 
 
 
@@ -197,12 +199,12 @@ Public IP and Location Info:
 
 #### IPv4 API
 
-ℹ️ `ipv4-api` valid choices: [`auto`, `ipapi`, `ipinfo`, `ipsb`, `identme`, `tnedime`]
+ℹ️ `ipv4-api` valid choices: [`auto-safe`, `auto`, `ip-api.com`, `ipinfo.io`, `ip.sb`, `ident.me`, `tnedi.me`, `ipapi.co`, `ipleak.net`, `my-ip.io`, `ifconfig.co`, `reallyfreegeoip.org`, `freeipapi.com`, `myip.la`]
 
-ℹ️ The default value: `auto`
+ℹ️ The default value: `auto-safe`
 
 ```console
-> ipspot --ipv4-api="ipinfo"
+> ipspot --ipv4-api="ipinfo.io"
 Private IP:
 
   10.36.18.154
@@ -267,6 +269,29 @@ 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.4] - 2025-06-09
+### Added
+- Support [ipapi.co](https://ipapi.co/json/)
+- Support [ipleak.net](https://ipleak.net/json/)
+- Support [my-ip.io](https://www.my-ip.io/)
+- Support [ifconfig.co](https://ifconfig.co/json)
+- Support [reallyfreegeoip.org](https://reallyfreegeoip.org/json/)
+- Support [myip.la](https://api.myip.la/en?json)
+- Support [freeipapi.com](https://freeipapi.com/api/json/)
+- `AUTO_SAFE` mode
+- `_get_json_standard` function
+- `_get_json_ipv4_forced` function
+- `--max-retries` argument
+- `--retry-delay` argument
+### Changed
+- `IPv4API.IPAPI` renamed to `IPv4API.IP_API_COM`
+- `IPv4API.IPINFO` renamed to `IPv4API.IPINFO_IO`
+- `IPv4API.IPSB` renamed to `IPv4API.IP_SB`
+- `IPv4API.IDENTME` renamed to `IPv4API.IDENT_ME`
+- `IPv4API.TNEDIME` renamed to `IPv4API.TNEDI_ME`
+- `get_public_ipv4` function modified
+- `filter_parameter` function renamed to `_filter_parameter`
+- `README.md` updated
 ## [0.3] - 2025-05-19
 ### Added
 - `is_ipv4` function
@@ -303,7 +328,8 @@ 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.3...dev
+[Unreleased]: https://github.com/openscilab/ipspot/compare/v0.4...dev
+[0.4]: https://github.com/openscilab/ipspot/compare/v0.3...v0.4
 [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 → ipspot-0.4}/README.md

@@ -52,13 +52,13 @@
 ## Installation		
 
 ### Source Code
-- Download [Version 0.3](https://github.com/openscilab/ipspot/archive/v0.3.zip) or [Latest Source](https://github.com/openscilab/ipspot/archive/dev.zip)
+- Download [Version 0.4](https://github.com/openscilab/ipspot/archive/v0.4.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.3`						
+- `pip install ipspot==0.4`						
 
 
 ## Usage
@@ -69,9 +69,11 @@
 
 ```pycon
 >>> from ipspot import get_public_ipv4, IPv4API
->>> get_public_ipv4(api=IPv4API.IPAPI)
+>>> get_public_ipv4(api=IPv4API.IP_API_COM)
 {'status': True, 'data': {'ip': 'xx.xx.xx.xx', 'api': 'ip-api.com'}}
->>> get_public_ipv4(api=IPv4API.IPAPI, geo=True, timeout=10)
+>>> get_public_ipv4(api=IPv4API.IP_API_COM, 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}
+>>> get_public_ipv4(api=IPv4API.IP_API_COM, geo=True, timeout=10, max_retries=5, retry_delay=4)
 {'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}
 ```
 
@@ -92,7 +94,7 @@
 ```console
 > ipspot --version
 
-0.3
+0.4
 ```
 
 #### Info
@@ -107,11 +109,11 @@
 |___||_|    |____/ | .__/  \___/  \__|
                    |_|
 
-__     __     ___      _____
-\ \   / / _  / _ \    |___ /
- \ \ / / (_)| | | |     |_ \
-  \ V /   _ | |_| | _  ___) |
-   \_/   (_) \___/ (_)|____/
+__     __     ___      _  _
+\ \   / / _  / _ \    | || |
+ \ \ / / (_)| | | |   | || |_
+  \ V /   _ | |_| | _ |__   _|
+   \_/   (_) \___/ (_)   |_|
 
 
 
@@ -147,12 +149,12 @@ Public IP and Location Info:
 
 #### IPv4 API
 
-ℹ️ `ipv4-api` valid choices: [`auto`, `ipapi`, `ipinfo`, `ipsb`, `identme`, `tnedime`]
+ℹ️ `ipv4-api` valid choices: [`auto-safe`, `auto`, `ip-api.com`, `ipinfo.io`, `ip.sb`, `ident.me`, `tnedi.me`, `ipapi.co`, `ipleak.net`, `my-ip.io`, `ifconfig.co`, `reallyfreegeoip.org`, `freeipapi.com`, `myip.la`]
 
-ℹ️ The default value: `auto`
+ℹ️ The default value: `auto-safe`
 
 ```console
-> ipspot --ipv4-api="ipinfo"
+> ipspot --ipv4-api="ipinfo.io"
 Private IP:
 
   10.36.18.154

{ipspot-0.3 → ipspot-0.4}/SECURITY.md

@@ -4,8 +4,8 @@
 
 | Version       | Supported          |
 | ------------- | ------------------ |
-| 0.3           | :white_check_mark: |
-| < 0.3         | :x:                |
+| 0.4           | :white_check_mark: |
+| < 0.4         | :x:                |
 
 ## Reporting a Vulnerability
 

{ipspot-0.3 → ipspot-0.4}/ipspot/cli.py

@@ -4,7 +4,7 @@ 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 .utils import _filter_parameter
 from .params import IPv4API, PARAMETERS_NAME_MAP
 from .params import IPSPOT_OVERVIEW, IPSPOT_REPO, IPSPOT_VERSION
 
@@ -17,14 +17,17 @@ def ipspot_info() -> None:  # pragma: no cover
     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
+def display_ip_info(ipv4_api: IPv4API = IPv4API.AUTO_SAFE, geo: bool=False,
+                    timeout: Union[float, Tuple[float, float]]=5,
+                    max_retries: int = 0, retry_delay: float = 1.0) -> 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
+    :param max_retries: number of retries
+    :param retry_delay: delay between retries (in seconds)
     """
     private_result = get_private_ipv4()
     print("Private IP:\n")
@@ -36,13 +39,18 @@ def display_ip_info(ipv4_api: IPv4API = IPv4API.AUTO, geo: bool=False,
         public_title += " and Location Info"
     public_title += ":\n"
     print(public_title)
-    public_result = get_public_ipv4(ipv4_api, geo=geo, timeout=timeout)
+    public_result = get_public_ipv4(
+        ipv4_api,
+        geo=geo,
+        timeout=timeout,
+        max_retries=max_retries,
+        retry_delay=retry_delay)
     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)))
+                    parameter=_filter_parameter(parameter)))
     else:
         print("  Error: {public_result[error]}".format(public_result=public_result))
 
@@ -56,11 +64,13 @@ def main() -> None:  # pragma: no cover
         type=str.lower,
         choices=[
             x.value for x in IPv4API],
-        default=IPv4API.AUTO.value)
+        default=IPv4API.AUTO_SAFE.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)
+    parser.add_argument('--max-retries', help='number of retries', type=int, default=0)
+    parser.add_argument('--retry-delay', help='delay between retries (in seconds)', type=float, default=1.0)
 
     args = parser.parse_args()
     if args.version:
@@ -70,4 +80,9 @@ def main() -> None:  # pragma: no cover
     else:
         ipv4_api = IPv4API(args.ipv4_api)
         geo = not args.no_geo
-        display_ip_info(ipv4_api=ipv4_api, geo=geo, timeout=args.timeout)
+        display_ip_info(
+            ipv4_api=ipv4_api,
+            geo=geo,
+            timeout=args.timeout,
+            max_retries=args.max_retries,
+            retry_delay=args.retry_delay)