# myIPstats 🌎
### Module Overview:
This module provides functionality to fetch IP information, including public and private IP addresses, location details, open ports, and more.
## How to Use:
- `myIPstats` (class): The main class containing methods to retrieve various IP-related information.
### Public IP:
- **`.public_ip()`** - Returns the public IP address.
- **`.public_hostname()`** - Returns the public hostname.
- **`.public_city()`** - Returns the public city.
- **`.public_region()`** - Returns the public region.
- **`.public_country()`** - Returns the public country.
- **`.public_loc()`** - Returns the public location.
- **`.public_org()`** - Returns the public organization.
- **`.public_postal()`** - Returns the public postal code.
- **`.public_fulladdress()`** - Returns a formatted string of public city, region, country, and postal code.
- **`.public_timezone()`** - Returns the public timezone.
- **`.public_all_stats(indent=False)`** - Returns all public information in JSON format.
### Private IP:
- **`.private_ip()`** - Returns the private IP address.
### Other Networking Information:
- **`.open_ports()`** - Returns a list of open ports on the local machine.
- **`.ip_probe(ip_address, indent=False)`** - Retrieves IP information for a specified IP address using the "https://ipinfo.io/{ip_address}/json" API.
### Example Usage:
Example:
```python
import myIPstats
ip_info = myIPstats.public_ip()
print(f"Public IP Address: {ip_info}")
```
Output:
```python
Public IP Address: 8.8.8.8
Raw data
{
"_id": null,
"home_page": "https://github.com/ericdennis7/myIPstats",
"name": "myIPstats",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Eric Dennis",
"author_email": "ericdennis11@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/44/66/fba3fd3826a5c99a225c142928f8d885ada81fc7c06fa3fbcbc579377741/myIPstats-1.4.tar.gz",
"platform": null,
"description": "# myIPstats \ud83c\udf0e\n\n### Module Overview:\n\nThis module provides functionality to fetch IP information, including public and private IP addresses, location details, open ports, and more.\n\n## How to Use:\n\n- `myIPstats` (class): The main class containing methods to retrieve various IP-related information.\n\n### Public IP:\n\n- **`.public_ip()`** - Returns the public IP address.\n\n- **`.public_hostname()`** - Returns the public hostname.\n\n- **`.public_city()`** - Returns the public city.\n\n- **`.public_region()`** - Returns the public region.\n\n- **`.public_country()`** - Returns the public country.\n\n- **`.public_loc()`** - Returns the public location.\n\n- **`.public_org()`** - Returns the public organization.\n\n- **`.public_postal()`** - Returns the public postal code.\n\n- **`.public_fulladdress()`** - Returns a formatted string of public city, region, country, and postal code.\n\n- **`.public_timezone()`** - Returns the public timezone.\n\n- **`.public_all_stats(indent=False)`** - Returns all public information in JSON format.\n\n ### Private IP:\n\n- **`.private_ip()`** - Returns the private IP address.\n\n ### Other Networking Information:\n\n- **`.open_ports()`** - Returns a list of open ports on the local machine.\n\n- **`.ip_probe(ip_address, indent=False)`** - Retrieves IP information for a specified IP address using the \"https://ipinfo.io/{ip_address}/json\" API.\n\n### Example Usage:\n\nExample:\n\n```python\nimport myIPstats\n\nip_info = myIPstats.public_ip()\nprint(f\"Public IP Address: {ip_info}\")\n```\n\nOutput:\n\n```python\nPublic IP Address: 8.8.8.8\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A module to fetch your IP address information.",
"version": "1.4",
"project_urls": {
"Homepage": "https://github.com/ericdennis7/myIPstats"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5bde3097a5b3bb98c7ac9e0f6b253d738dd1117ca6df3d8671da2b47775ab32",
"md5": "b74e051ba5c81481b9766bedac0432ff",
"sha256": "18262f8da5423d042a2d23ca2d1358cb3b95356ebc2885ec0c81f49f0138ae59"
},
"downloads": -1,
"filename": "myIPstats-1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b74e051ba5c81481b9766bedac0432ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3776,
"upload_time": "2024-01-16T23:37:56",
"upload_time_iso_8601": "2024-01-16T23:37:56.452887Z",
"url": "https://files.pythonhosted.org/packages/b5/bd/e3097a5b3bb98c7ac9e0f6b253d738dd1117ca6df3d8671da2b47775ab32/myIPstats-1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4466fba3fd3826a5c99a225c142928f8d885ada81fc7c06fa3fbcbc579377741",
"md5": "590fada23daee952e4d3ab95c8b6e076",
"sha256": "9af55621a48a9cb8218e61d7a88bf23a39b31146e2f2606ecc65cc13eaad00a2"
},
"downloads": -1,
"filename": "myIPstats-1.4.tar.gz",
"has_sig": false,
"md5_digest": "590fada23daee952e4d3ab95c8b6e076",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3421,
"upload_time": "2024-01-16T23:37:57",
"upload_time_iso_8601": "2024-01-16T23:37:57.936481Z",
"url": "https://files.pythonhosted.org/packages/44/66/fba3fd3826a5c99a225c142928f8d885ada81fc7c06fa3fbcbc579377741/myIPstats-1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-16 23:37:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ericdennis7",
"github_project": "myIPstats",
"github_not_found": true,
"lcname": "myipstats"
}
JSON
