ipspot 0.0.0__py3-none-any.whl → 0.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ipspot/__init__.py +5 -2
- ipspot/__main__.py +7 -0
- ipspot/functions.py +218 -0
- ipspot/params.py +41 -0
- ipspot-0.2.dist-info/METADATA +294 -0
- ipspot-0.2.dist-info/RECORD +11 -0
- {ipspot-0.0.0.dist-info → ipspot-0.2.dist-info}/WHEEL +1 -1
- ipspot-0.2.dist-info/entry_points.txt +2 -0
- ipspot-0.2.dist-info/licenses/AUTHORS.md +11 -0
- ipspot-0.2.dist-info/licenses/LICENSE +21 -0
- ipspot-0.0.0.dist-info/METADATA +0 -23
- ipspot-0.0.0.dist-info/RECORD +0 -5
- {ipspot-0.0.0.dist-info → ipspot-0.2.dist-info}/top_level.txt +0 -0
ipspot/__init__.py
CHANGED
ipspot/__main__.py
ADDED
ipspot/functions.py
ADDED
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
"""ipspot functions."""
|
|
3
|
+
import argparse
|
|
4
|
+
import socket
|
|
5
|
+
from typing import Union, Dict, Tuple, Any
|
|
6
|
+
import requests
|
|
7
|
+
from art import tprint
|
|
8
|
+
from .params import REQUEST_HEADERS, IPv4API, PARAMETERS_NAME_MAP
|
|
9
|
+
from .params import IPSPOT_OVERVIEW, IPSPOT_REPO, IPSPOT_VERSION
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def ipspot_info() -> None: # pragma: no cover
|
|
13
|
+
"""Print ipspot details."""
|
|
14
|
+
tprint("IPSpot")
|
|
15
|
+
tprint("V:" + IPSPOT_VERSION)
|
|
16
|
+
print(IPSPOT_OVERVIEW)
|
|
17
|
+
print("Repo : " + IPSPOT_REPO)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
def get_private_ipv4() -> Dict[str, Union[bool, Dict[str, str], str]]:
|
|
21
|
+
"""Retrieve the private IPv4 address."""
|
|
22
|
+
try:
|
|
23
|
+
hostname = socket.gethostname()
|
|
24
|
+
private_ip = socket.gethostbyname(hostname)
|
|
25
|
+
return {"status": True, "data": {"ip": private_ip}}
|
|
26
|
+
except Exception as e:
|
|
27
|
+
return {"status": False, "error": str(e)}
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
def _ipsb_ipv4(geo: bool=False, timeout: Union[float, Tuple[float, float]]
|
|
31
|
+
=5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
|
|
32
|
+
"""
|
|
33
|
+
Get public IP and geolocation using ip.sb.
|
|
34
|
+
|
|
35
|
+
:param geo: geolocation flag
|
|
36
|
+
:param timeout: timeout value for API
|
|
37
|
+
"""
|
|
38
|
+
try:
|
|
39
|
+
response = requests.get("https://api.ip.sb/geoip", headers=REQUEST_HEADERS, timeout=timeout)
|
|
40
|
+
response.raise_for_status()
|
|
41
|
+
data = response.json()
|
|
42
|
+
result = {"status": True, "data": {"ip": data.get("ip"), "api": "ip.sb"}}
|
|
43
|
+
if geo:
|
|
44
|
+
geo_data = {
|
|
45
|
+
"city": data.get("city"),
|
|
46
|
+
"region": data.get("region"),
|
|
47
|
+
"country": data.get("country"),
|
|
48
|
+
"country_code": data.get("country_code"),
|
|
49
|
+
"latitude": data.get("latitude"),
|
|
50
|
+
"longitude": data.get("longitude"),
|
|
51
|
+
"organization": data.get("organization"),
|
|
52
|
+
"timezone": data.get("timezone")
|
|
53
|
+
}
|
|
54
|
+
result["data"].update(geo_data)
|
|
55
|
+
return result
|
|
56
|
+
except Exception as e:
|
|
57
|
+
return {"status": False, "error": str(e)}
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
def _ipapi_ipv4(geo: bool=False, timeout: Union[float, Tuple[float, float]]
|
|
61
|
+
=5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
|
|
62
|
+
"""
|
|
63
|
+
Get public IP and geolocation using ip-api.com.
|
|
64
|
+
|
|
65
|
+
:param geo: geolocation flag
|
|
66
|
+
:param timeout: timeout value for API
|
|
67
|
+
"""
|
|
68
|
+
try:
|
|
69
|
+
response = requests.get("http://ip-api.com/json/", headers=REQUEST_HEADERS, timeout=timeout)
|
|
70
|
+
response.raise_for_status()
|
|
71
|
+
data = response.json()
|
|
72
|
+
|
|
73
|
+
if data.get("status") != "success":
|
|
74
|
+
return {"status": False, "error": "ip-api lookup failed"}
|
|
75
|
+
result = {"status": True, "data": {"ip": data.get("query"), "api": "ip-api.com"}}
|
|
76
|
+
if geo:
|
|
77
|
+
geo_data = {
|
|
78
|
+
"city": data.get("city"),
|
|
79
|
+
"region": data.get("regionName"),
|
|
80
|
+
"country": data.get("country"),
|
|
81
|
+
"country_code": data.get("countryCode"),
|
|
82
|
+
"latitude": data.get("lat"),
|
|
83
|
+
"longitude": data.get("lon"),
|
|
84
|
+
"organization": data.get("org"),
|
|
85
|
+
"timezone": data.get("timezone")
|
|
86
|
+
}
|
|
87
|
+
result["data"].update(geo_data)
|
|
88
|
+
return result
|
|
89
|
+
except Exception as e:
|
|
90
|
+
return {"status": False, "error": str(e)}
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
def _ipinfo_ipv4(geo: bool=False, timeout: Union[float, Tuple[float, float]]
|
|
94
|
+
=5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
|
|
95
|
+
"""
|
|
96
|
+
Get public IP and geolocation using ipinfo.io.
|
|
97
|
+
|
|
98
|
+
:param geo: geolocation flag
|
|
99
|
+
:param timeout: timeout value for API
|
|
100
|
+
"""
|
|
101
|
+
try:
|
|
102
|
+
response = requests.get("https://ipinfo.io/json", headers=REQUEST_HEADERS, timeout=timeout)
|
|
103
|
+
response.raise_for_status()
|
|
104
|
+
data = response.json()
|
|
105
|
+
result = {"status": True, "data": {"ip": data.get("ip"), "api": "ipinfo.io"}}
|
|
106
|
+
if geo:
|
|
107
|
+
loc = data.get("loc", "").split(",")
|
|
108
|
+
geo_data = {
|
|
109
|
+
"city": data.get("city"),
|
|
110
|
+
"region": data.get("region"),
|
|
111
|
+
"country": None,
|
|
112
|
+
"country_code": data.get("country"),
|
|
113
|
+
"latitude": float(loc[0]) if len(loc) == 2 else None,
|
|
114
|
+
"longitude": float(loc[1]) if len(loc) == 2 else None,
|
|
115
|
+
"organization": data.get("org"),
|
|
116
|
+
"timezone": data.get("timezone")
|
|
117
|
+
}
|
|
118
|
+
result["data"].update(geo_data)
|
|
119
|
+
return result
|
|
120
|
+
except Exception as e:
|
|
121
|
+
return {"status": False, "error": str(e)}
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
def get_public_ipv4(api: IPv4API=IPv4API.AUTO, geo: bool=False,
|
|
125
|
+
timeout: Union[float, Tuple[float, float]]=5) -> Dict[str, Union[bool, Dict[str, Union[str, float]], str]]:
|
|
126
|
+
"""
|
|
127
|
+
Get public IPv4 and geolocation info based on the selected API.
|
|
128
|
+
|
|
129
|
+
:param api: public IPv4 API
|
|
130
|
+
:param geo: geolocation flag
|
|
131
|
+
:param timeout: timeout value for API
|
|
132
|
+
"""
|
|
133
|
+
api_map = {
|
|
134
|
+
IPv4API.IPAPI: _ipapi_ipv4,
|
|
135
|
+
IPv4API.IPINFO: _ipinfo_ipv4,
|
|
136
|
+
IPv4API.IPSB: _ipsb_ipv4
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
if api == IPv4API.AUTO:
|
|
140
|
+
for _, func in api_map.items():
|
|
141
|
+
result = func(geo=geo, timeout=timeout)
|
|
142
|
+
if result["status"]:
|
|
143
|
+
return result
|
|
144
|
+
return {"status": False, "error": "All attempts failed."}
|
|
145
|
+
else:
|
|
146
|
+
func = api_map.get(api)
|
|
147
|
+
if func:
|
|
148
|
+
return func(geo=geo, timeout=timeout)
|
|
149
|
+
return {"status": False, "error": "Unsupported API: {api}".format(api=api)}
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
def filter_parameter(parameter: Any) -> Any:
|
|
153
|
+
"""
|
|
154
|
+
Filter input parameter.
|
|
155
|
+
|
|
156
|
+
:param parameter: input parameter
|
|
157
|
+
"""
|
|
158
|
+
if parameter is None:
|
|
159
|
+
return "N/A"
|
|
160
|
+
if isinstance(parameter, str) and len(parameter.strip()) == 0:
|
|
161
|
+
return "N/A"
|
|
162
|
+
return parameter
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
def display_ip_info(ipv4_api: IPv4API = IPv4API.AUTO, geo: bool=False,
|
|
166
|
+
timeout: Union[float, Tuple[float, float]]=5) -> None: # pragma: no cover
|
|
167
|
+
"""
|
|
168
|
+
Print collected IP and location data.
|
|
169
|
+
|
|
170
|
+
:param ipv4_api: public IPv4 API
|
|
171
|
+
:param geo: geolocation flag
|
|
172
|
+
:param timeout: timeout value for API
|
|
173
|
+
"""
|
|
174
|
+
private_result = get_private_ipv4()
|
|
175
|
+
print("Private IP:\n")
|
|
176
|
+
print(" IP: {private_result[data][ip]}".format(private_result=private_result) if private_result["status"]
|
|
177
|
+
else " Error: {private_result[error]}".format(private_result=private_result))
|
|
178
|
+
|
|
179
|
+
public_title = "\nPublic IP"
|
|
180
|
+
if geo:
|
|
181
|
+
public_title += " and Location Info"
|
|
182
|
+
public_title += ":\n"
|
|
183
|
+
print(public_title)
|
|
184
|
+
public_result = get_public_ipv4(ipv4_api, geo=geo, timeout=timeout)
|
|
185
|
+
if public_result["status"]:
|
|
186
|
+
for name, parameter in sorted(public_result["data"].items()):
|
|
187
|
+
print(
|
|
188
|
+
" {name}: {parameter}".format(
|
|
189
|
+
name=PARAMETERS_NAME_MAP[name],
|
|
190
|
+
parameter=filter_parameter(parameter)))
|
|
191
|
+
else:
|
|
192
|
+
print(" Error: {public_result[error]}".format(public_result=public_result))
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
def main() -> None: # pragma: no cover
|
|
196
|
+
"""CLI main function."""
|
|
197
|
+
parser = argparse.ArgumentParser()
|
|
198
|
+
parser.add_argument(
|
|
199
|
+
'--ipv4-api',
|
|
200
|
+
help='public IPv4 API',
|
|
201
|
+
type=str.lower,
|
|
202
|
+
choices=[
|
|
203
|
+
x.value for x in IPv4API],
|
|
204
|
+
default=IPv4API.AUTO.value)
|
|
205
|
+
parser.add_argument('--info', help='info', nargs="?", const=1)
|
|
206
|
+
parser.add_argument('--version', help='version', nargs="?", const=1)
|
|
207
|
+
parser.add_argument('--no-geo', help='no geolocation data', nargs="?", const=1, default=False)
|
|
208
|
+
parser.add_argument('--timeout', help='timeout for the API request', type=float, default=5.0)
|
|
209
|
+
|
|
210
|
+
args = parser.parse_args()
|
|
211
|
+
if args.version:
|
|
212
|
+
print(IPSPOT_VERSION)
|
|
213
|
+
elif args.info:
|
|
214
|
+
ipspot_info()
|
|
215
|
+
else:
|
|
216
|
+
ipv4_api = IPv4API(args.ipv4_api)
|
|
217
|
+
geo = not args.no_geo
|
|
218
|
+
display_ip_info(ipv4_api=ipv4_api, geo=geo, timeout=args.timeout)
|
ipspot/params.py
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
"""ipspot params."""
|
|
3
|
+
from enum import Enum
|
|
4
|
+
|
|
5
|
+
IPSPOT_VERSION = "0.2"
|
|
6
|
+
|
|
7
|
+
IPSPOT_OVERVIEW = '''
|
|
8
|
+
IPSpot is a Python library for retrieving the current system's IP address and location information.
|
|
9
|
+
It currently supports public and private IPv4 detection using multiple API providers with a fallback mechanism for reliability.
|
|
10
|
+
Designed with simplicity and modularity in mind, IPSpot offers quick IP and geolocation lookups directly from your machine.
|
|
11
|
+
'''
|
|
12
|
+
|
|
13
|
+
IPSPOT_REPO = "https://github.com/openscilab/ipspot"
|
|
14
|
+
|
|
15
|
+
REQUEST_HEADERS = {
|
|
16
|
+
'User-Agent': 'IPSpot/{version} ({repo})'.format(version=IPSPOT_VERSION, repo=IPSPOT_REPO),
|
|
17
|
+
'Accept': 'application/json'
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class IPv4API(Enum):
|
|
22
|
+
"""Public IPv4 API enum."""
|
|
23
|
+
|
|
24
|
+
AUTO = "auto"
|
|
25
|
+
IPAPI = "ipapi"
|
|
26
|
+
IPINFO = "ipinfo"
|
|
27
|
+
IPSB = "ipsb"
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
PARAMETERS_NAME_MAP = {
|
|
31
|
+
"ip": "IP",
|
|
32
|
+
"city": "City",
|
|
33
|
+
"region": "Region",
|
|
34
|
+
"country": "Country",
|
|
35
|
+
"country_code": "Country Code",
|
|
36
|
+
"timezone": "Timezone",
|
|
37
|
+
"latitude": "Latitude",
|
|
38
|
+
"longitude": "Longitude",
|
|
39
|
+
"organization": "Organization",
|
|
40
|
+
"api": "API"
|
|
41
|
+
}
|
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ipspot
|
|
3
|
+
Version: 0.2
|
|
4
|
+
Summary: IPSpot: A Python Tool to Fetch the System's IP Address
|
|
5
|
+
Home-page: https://github.com/openscilab/ipspot
|
|
6
|
+
Download-URL: https://github.com/openscilab/ipspot/tarball/v0.2
|
|
7
|
+
Author: IPSpot Development Team
|
|
8
|
+
Author-email: ipspot@openscilab.com
|
|
9
|
+
License: MIT
|
|
10
|
+
Project-URL: Source, https://github.com/openscilab/ipspot
|
|
11
|
+
Keywords: ip ipv4 geo geolocation network location ipspot cli
|
|
12
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
13
|
+
Classifier: Natural Language :: English
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
23
|
+
Classifier: Intended Audience :: Developers
|
|
24
|
+
Classifier: Intended Audience :: Education
|
|
25
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
26
|
+
Classifier: Topic :: System :: Monitoring
|
|
27
|
+
Classifier: Topic :: System :: Networking :: Monitoring
|
|
28
|
+
Classifier: Topic :: Utilities
|
|
29
|
+
Requires-Python: >=3.7
|
|
30
|
+
Description-Content-Type: text/markdown
|
|
31
|
+
License-File: LICENSE
|
|
32
|
+
License-File: AUTHORS.md
|
|
33
|
+
Requires-Dist: art>=5.3
|
|
34
|
+
Requires-Dist: requests>=2.20.0
|
|
35
|
+
Dynamic: author
|
|
36
|
+
Dynamic: author-email
|
|
37
|
+
Dynamic: classifier
|
|
38
|
+
Dynamic: description
|
|
39
|
+
Dynamic: description-content-type
|
|
40
|
+
Dynamic: download-url
|
|
41
|
+
Dynamic: home-page
|
|
42
|
+
Dynamic: keywords
|
|
43
|
+
Dynamic: license
|
|
44
|
+
Dynamic: license-file
|
|
45
|
+
Dynamic: project-url
|
|
46
|
+
Dynamic: requires-dist
|
|
47
|
+
Dynamic: requires-python
|
|
48
|
+
Dynamic: summary
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
<div align="center">
|
|
52
|
+
<img src="https://github.com/openscilab/ipspot/raw/main/otherfiles/logo.png" width="350">
|
|
53
|
+
<h1>IPSpot: A Python Tool to Fetch the System's IP Address</h1>
|
|
54
|
+
<br/>
|
|
55
|
+
<a href="https://badge.fury.io/py/ipspot"><img src="https://badge.fury.io/py/ipspot.svg" alt="PyPI version"></a>
|
|
56
|
+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
|
|
57
|
+
<a href="https://github.com/openscilab/ipspot"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/openscilab/ipspot"></a>
|
|
58
|
+
<a href="https://discord.gg/yyDV3T4cwU"><img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel"></a>
|
|
59
|
+
</div>
|
|
60
|
+
|
|
61
|
+
## Overview
|
|
62
|
+
|
|
63
|
+
<p align="justify">
|
|
64
|
+
<b>IPSpot</b> is a Python library for retrieving the current system's IP address and location information. It currently supports public and private <b>IPv4</b> detection using multiple API providers with a fallback mechanism for reliability. Designed with simplicity and modularity in mind, <b>IPSpot</b> offers quick IP and geolocation lookups directly from your machine.
|
|
65
|
+
</p>
|
|
66
|
+
|
|
67
|
+
<table>
|
|
68
|
+
<tr>
|
|
69
|
+
<td align="center">PyPI Counter</td>
|
|
70
|
+
<td align="center"><a href="http://pepy.tech/project/ipspot"><img src="http://pepy.tech/badge/ipspot"></a></td>
|
|
71
|
+
</tr>
|
|
72
|
+
<tr>
|
|
73
|
+
<td align="center">Github Stars</td>
|
|
74
|
+
<td align="center"><a href="https://github.com/openscilab/ipspot"><img src="https://img.shields.io/github/stars/openscilab/ipspot.svg?style=social&label=Stars"></a></td>
|
|
75
|
+
</tr>
|
|
76
|
+
</table>
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<table>
|
|
81
|
+
<tr>
|
|
82
|
+
<td align="center">Branch</td>
|
|
83
|
+
<td align="center">main</td>
|
|
84
|
+
<td align="center">dev</td>
|
|
85
|
+
</tr>
|
|
86
|
+
<tr>
|
|
87
|
+
<td align="center">CI</td>
|
|
88
|
+
<td align="center"><img src="https://github.com/openscilab/ipspot/actions/workflows/test.yml/badge.svg?branch=main"></td>
|
|
89
|
+
<td align="center"><img src="https://github.com/openscilab/ipspot/actions/workflows/test.yml/badge.svg?branch=dev"></td>
|
|
90
|
+
</tr>
|
|
91
|
+
</table>
|
|
92
|
+
|
|
93
|
+
<table>
|
|
94
|
+
<tr>
|
|
95
|
+
<td align="center">Code Quality</td>
|
|
96
|
+
<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>
|
|
97
|
+
<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>
|
|
98
|
+
</tr>
|
|
99
|
+
</table>
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
## Installation
|
|
103
|
+
|
|
104
|
+
### Source Code
|
|
105
|
+
- Download [Version 0.2](https://github.com/openscilab/ipspot/archive/v0.2.zip) or [Latest Source](https://github.com/openscilab/ipspot/archive/dev.zip)
|
|
106
|
+
- `pip install .`
|
|
107
|
+
|
|
108
|
+
### PyPI
|
|
109
|
+
|
|
110
|
+
- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
|
|
111
|
+
- `pip install ipspot==0.2`
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
## Usage
|
|
115
|
+
|
|
116
|
+
### Library
|
|
117
|
+
|
|
118
|
+
#### Public IPv4
|
|
119
|
+
|
|
120
|
+
```pycon
|
|
121
|
+
>>> from ipspot import get_public_ipv4, IPv4API
|
|
122
|
+
>>> get_public_ipv4(api=IPv4API.IPAPI)
|
|
123
|
+
{'status': True, 'data': {'ip': 'xx.xx.xx.xx', 'api': 'ip-api.com'}}
|
|
124
|
+
>>> get_public_ipv4(api=IPv4API.IPAPI, geo=True, timeout=10)
|
|
125
|
+
{'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}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
#### Private IPv4
|
|
129
|
+
|
|
130
|
+
```pycon
|
|
131
|
+
>>> from ipspot import get_private_ipv4
|
|
132
|
+
>>> get_private_ipv4()
|
|
133
|
+
{'status': True, 'data': {'ip': '10.36.18.154'}}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### CLI
|
|
137
|
+
|
|
138
|
+
ℹ️ You can use `ipspot` or `python -m ipspot` to run this program
|
|
139
|
+
|
|
140
|
+
#### Version
|
|
141
|
+
|
|
142
|
+
```console
|
|
143
|
+
> ipspot --version
|
|
144
|
+
|
|
145
|
+
0.2
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
#### Info
|
|
149
|
+
|
|
150
|
+
```console
|
|
151
|
+
> ipspot --info
|
|
152
|
+
|
|
153
|
+
___ ____ ____ _
|
|
154
|
+
|_ _|| _ \ / ___| _ __ ___ | |_
|
|
155
|
+
| | | |_) |\___ \ | '_ \ / _ \ | __|
|
|
156
|
+
| | | __/ ___) || |_) || (_) || |_
|
|
157
|
+
|___||_| |____/ | .__/ \___/ \__|
|
|
158
|
+
|_|
|
|
159
|
+
|
|
160
|
+
__ __ ___ ____
|
|
161
|
+
\ \ / / _ / _ \ |___ \
|
|
162
|
+
\ \ / / (_)| | | | __) |
|
|
163
|
+
\ V / _ | |_| | _ / __/
|
|
164
|
+
\_/ (_) \___/ (_)|_____|
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
IPSpot is a Python library for retrieving the current system's IP address and location information.
|
|
169
|
+
It currently supports public and private IPv4 detection using multiple API providers with a fallback mechanism for reliability.
|
|
170
|
+
Designed with simplicity and modularity in mind, IPSpot offers quick IP and geolocation lookups directly from your machine.
|
|
171
|
+
|
|
172
|
+
Repo : https://github.com/openscilab/ipspot
|
|
173
|
+
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
#### Basic
|
|
177
|
+
|
|
178
|
+
```console
|
|
179
|
+
> ipspot
|
|
180
|
+
Private IP:
|
|
181
|
+
|
|
182
|
+
10.36.18.154
|
|
183
|
+
|
|
184
|
+
Public IP and Location Info:
|
|
185
|
+
|
|
186
|
+
API: ip-api.com
|
|
187
|
+
City: Southampton
|
|
188
|
+
Country: United Kingdom
|
|
189
|
+
Country Code: GB
|
|
190
|
+
IP: xx.xx.xx.xx
|
|
191
|
+
Latitude: 50.9097
|
|
192
|
+
Longitude: -1.4043
|
|
193
|
+
Organization: N/A
|
|
194
|
+
Region: England
|
|
195
|
+
Timezone: Europe/London
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
#### IPv4 API
|
|
199
|
+
|
|
200
|
+
ℹ️ `ipv4-api` valid choices: [`auto`, `ipapi`, `ipinfo`, `ipsb`]
|
|
201
|
+
|
|
202
|
+
ℹ️ The default value: `auto`
|
|
203
|
+
|
|
204
|
+
```console
|
|
205
|
+
> ipspot --ipv4-api="ipinfo"
|
|
206
|
+
Private IP:
|
|
207
|
+
|
|
208
|
+
10.36.18.154
|
|
209
|
+
|
|
210
|
+
Public IP and Location Info:
|
|
211
|
+
|
|
212
|
+
API: ipinfo.io
|
|
213
|
+
City: Leatherhead
|
|
214
|
+
Country: N/A
|
|
215
|
+
Country Code: GB
|
|
216
|
+
IP: xx.xx.xx.xx
|
|
217
|
+
Latitude: 51.2965
|
|
218
|
+
Longitude: -0.3338
|
|
219
|
+
Organization: AS212238 Datacamp Limited
|
|
220
|
+
Region: England
|
|
221
|
+
Timezone: Europe/London
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
#### No Geolocation
|
|
225
|
+
|
|
226
|
+
```console
|
|
227
|
+
> ipspot --no-geo
|
|
228
|
+
Private IP:
|
|
229
|
+
|
|
230
|
+
IP: 10.36.18.154
|
|
231
|
+
|
|
232
|
+
Public IP:
|
|
233
|
+
|
|
234
|
+
API: ipinfo.io
|
|
235
|
+
IP: xx.xx.xx.xx
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
## Issues & Bug Reports
|
|
239
|
+
|
|
240
|
+
Just fill an issue and describe it. We'll check it ASAP!
|
|
241
|
+
|
|
242
|
+
- Please complete the issue template
|
|
243
|
+
|
|
244
|
+
You can also join our discord server
|
|
245
|
+
|
|
246
|
+
<a href="https://discord.gg/yyDV3T4cwU">
|
|
247
|
+
<img src="https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge" alt="Discord Channel">
|
|
248
|
+
</a>
|
|
249
|
+
|
|
250
|
+
## Show Your Support
|
|
251
|
+
|
|
252
|
+
<h3>Star This Repo</h3>
|
|
253
|
+
|
|
254
|
+
Give a ⭐️ if this project helped you!
|
|
255
|
+
|
|
256
|
+
<h3>Donate to Our Project</h3>
|
|
257
|
+
|
|
258
|
+
If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-)
|
|
259
|
+
|
|
260
|
+
<a href="https://openscilab.com/#donation" target="_blank"><img src="https://github.com/openscilab/ipspot/raw/main/otherfiles/donation.png" height="90px" width="270px" alt="IPSpot Donation"></a>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
# Changelog
|
|
264
|
+
All notable changes to this project will be documented in this file.
|
|
265
|
+
|
|
266
|
+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
267
|
+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
268
|
+
|
|
269
|
+
## [Unreleased]
|
|
270
|
+
## [0.2] - 2025-05-04
|
|
271
|
+
### Added
|
|
272
|
+
- Support [ip.sb](https://api.ip.sb/geoip)
|
|
273
|
+
- `--timeout` argument
|
|
274
|
+
### Changed
|
|
275
|
+
- `README.md` updated
|
|
276
|
+
- Requests header updated
|
|
277
|
+
- Test system modified
|
|
278
|
+
## [0.1] - 2025-04-25
|
|
279
|
+
### Added
|
|
280
|
+
- Support [ipinfo.io](https://ipinfo.io)
|
|
281
|
+
- Support [ip-api.com](https://ip-api.com)
|
|
282
|
+
- `get_private_ipv4` function
|
|
283
|
+
- `get_public_ipv4` function
|
|
284
|
+
- `--info` and `--version` arguments
|
|
285
|
+
- `--ipv4-api` argument
|
|
286
|
+
- `--no-geo` argument
|
|
287
|
+
- Logo
|
|
288
|
+
|
|
289
|
+
[Unreleased]: https://github.com/openscilab/ipspot/compare/v0.2...dev
|
|
290
|
+
[0.2]: https://github.com/openscilab/ipspot/compare/v0.1...v0.2
|
|
291
|
+
[0.1]: https://github.com/openscilab/ipspot/compare/3216fb7...v0.1
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
ipspot/__init__.py,sha256=cxty-JGyo_sLeQd7bHrXUoEabl3QhLtgA9UtLcStp6o,176
|
|
2
|
+
ipspot/__main__.py,sha256=17x2Q5vGORstO8mZ8B9aDixcOK5Gl71Ej5fC5P1EBKY,111
|
|
3
|
+
ipspot/functions.py,sha256=JNeLJw-zIZzQQhul1SHPBzBNiFtoJvjzMUIqkeJNn3A,7862
|
|
4
|
+
ipspot/params.py,sha256=I-waqgQ83px4ybrgpD1MAYFi7Zre1T9GSBN25-eZrVk,1099
|
|
5
|
+
ipspot-0.2.dist-info/licenses/AUTHORS.md,sha256=AgFL2paPd70ItL_YK18lWm_NjNWytKZHmR57o-et8kU,236
|
|
6
|
+
ipspot-0.2.dist-info/licenses/LICENSE,sha256=0aOd4wzZRoSH_35UZXRHS7alPFTtuFEBJrajLuonEIw,1067
|
|
7
|
+
ipspot-0.2.dist-info/METADATA,sha256=yQNY-arJj8IQfVT2vvySrEcytBVzvYCiac5QhLFK1Dk,8798
|
|
8
|
+
ipspot-0.2.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
|
|
9
|
+
ipspot-0.2.dist-info/entry_points.txt,sha256=SYgm9eGlJY7AGqi4_PmFVXwjEoylPPnAHeAeJPtYdjk,49
|
|
10
|
+
ipspot-0.2.dist-info/top_level.txt,sha256=v0WgE1z2iCy_bXU53fVcllwHLTvGNBIvq8u3KPC2_Sc,7
|
|
11
|
+
ipspot-0.2.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 OpenSciLab
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
ipspot-0.0.0.dist-info/METADATA
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: ipspot
|
|
3
|
-
Version: 0.0.0
|
|
4
|
-
Summary: This name has been reserved using Reserver
|
|
5
|
-
Home-page: https://url.com
|
|
6
|
-
Download-URL: https://download_url.com
|
|
7
|
-
Author: Development Team
|
|
8
|
-
Author-email: test@test.com
|
|
9
|
-
License: MIT
|
|
10
|
-
Project-URL: Source, https://github.com/source
|
|
11
|
-
Keywords: python3 python reserve reserver reserved
|
|
12
|
-
Classifier: Development Status :: 1 - Planning
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.6
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.7
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
-
Requires-Python: >=3.6
|
|
21
|
-
Description-Content-Type: text/markdown
|
|
22
|
-
|
|
23
|
-
This name has been reserved using [Reserver](https://github.com/openscilab/reserver).
|
ipspot-0.0.0.dist-info/RECORD
DELETED
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
ipspot/__init__.py,sha256=8FV5c2U1i76kXBNT6Wa-BprTZ8gEpqGmceJzD0DSOaQ,46
|
|
2
|
-
ipspot-0.0.0.dist-info/METADATA,sha256=BPZlOQU_qWzl09eMkOUCMRMMygI7YkKhSbXJjqpa6Vo,905
|
|
3
|
-
ipspot-0.0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
|
|
4
|
-
ipspot-0.0.0.dist-info/top_level.txt,sha256=v0WgE1z2iCy_bXU53fVcllwHLTvGNBIvq8u3KPC2_Sc,7
|
|
5
|
-
ipspot-0.0.0.dist-info/RECORD,,
|
|
File without changes
|