[](https://github.com/rly0nheart/ipmap/actions/workflows/docker-image.yml)
[](https://github.com/rly0nheart/ipmap/actions/workflows/codeql.yml)
[English](https://github.com/rly0nheart/ipmap/blob/master/README.md) •
[简体中文](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=zh-CN&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[正體中文](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=zh-TW&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Lengua española](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=es&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Deutsche](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=de&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Svenska](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=sv&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[한국어](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=ko&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Français](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=fr&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[हिन्दी](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=hi&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Português](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=pt&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Italian](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=it&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Русский](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=ru&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Indonesian](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=id&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[فارسی](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=fa&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[عربي](https://github.com/rly0nheart/ipmap/blob/master/README_ar.md) •
[Türkçe](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=tr&_x_tr_hl=en-US&_x_tr_pto=wapp) •
[Polskie](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=pl&_x_tr_hl=en-US&_x_tr_pto=wapp)
IPMap geolocates a given ip address/addresses from a file, then generates a [leaflet](https://github.com/leaflet/leaflet) map pin-pointing the location of each ip address on it (with the right argument).
# Features
* Looks up ip address(es) and returns the associated information.
* Looks up an ip address(es) and returns the associated information then pin points the location of the ip address(es) on a generated leaflet map.
* Opens Google Earth on the location of the specified ip address(es).
* Generated maps are saved to the `maps` directory in the user's home directory which is created on runtime if it does not exist.
* Does not use external dependencies for the map, instead uses an already written html [map template](ipmap/data/templates/map.html).
# Installation
## PyPI
IPMap can be installed from PyPI by running the following command in terminal/command prompt
```
pip install ipmap
```
## GitHub
Or if you prefer to install it from source, you can run the following command
```
pip install git+https://github.com/rly0nheart/ipmap.git
```
## Build from source
```Python
# install poetry
pip install poetry
# clone the project
git clone https://github.com/rly0nheart/ipmap
# move to the ipmap directory
cd ipmap
# build the wheel file
poetry build
# install the built wheel (Linux)
pip install dist/*.whl
# install built wheel (Windows)
pip install .\dist\generated-wheel-file-name.whl
```
# Usage
To see the usage, you can simply run
```
ipmap --help
```
The output should look like the following
```
usage:
Geolocate IP Address(es) (with an interactive map)
--------------------------------------------------
ipmap <ip> --map
Open Google Earth on the given coordinates
--------------------------------------------
ipmap <ip> --earth
Lookup IP Address(es) (same as map but without an interactive map)
------------------------------------------------------------------
ipmap <ip> --lookup
IPMap (IP Mapper) — by Richard Mwewa (https://about.me/rly0nheart)
positional arguments:
ip target ip address
options:
-h, --help show this help message and exit
-e, --earth Open Google Earth on the location of a given ip
-l, --lookup Lookup an ip (like --map, but without an interactive
map)
-m, --map Geolocate an ip (with an interactive map)
-o OUTPUT, --output OUTPUT
map output name (default ipmap)
-v, --version show program's version number and exit
A cross-platform easy-to-use ip geolocation & mapping tool.
```
> You can also pass a file containing ip addresses to `--ip`, IPMap will process the file accordingly and read each ip line by line.
# Translations
* [Justin Clark](https://github.com/jclark1913) - Added [README_ar.md](https://github.com/rly0nheart/ipmap/blob/master/README_ar.md) for Arabic translation
> If you'd like to translate the project's README in any language, or if you can improve the (Google translated) translations of the already existing README's, feel free to open a pull request with your translations. I'd be more than happy to include them in the project :).
Raw data
{
"_id": null,
"home_page": "https://github.com/rly0nheart/ipmap",
"name": "ipmap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "mapping,geolocation,ip-address-geolocation,ip-address-lookup,ip-mapping",
"author": "Richard Mwewa",
"author_email": "rly0nheart@duck.com",
"download_url": "https://files.pythonhosted.org/packages/98/e8/3da87c334cce51e92afee371787c89d54c8a2f91c16668e6d8aa4be2805d/ipmap-1.2.0.tar.gz",
"platform": null,
"description": "[](https://github.com/rly0nheart/ipmap/actions/workflows/docker-image.yml)\n[](https://github.com/rly0nheart/ipmap/actions/workflows/codeql.yml)\n\n\n\n\n[English](https://github.com/rly0nheart/ipmap/blob/master/README.md) \u2022\n[\u7b80\u4f53\u4e2d\u6587](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=zh-CN&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[\u6b63\u9ad4\u4e2d\u6587](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=zh-TW&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[Lengua espa\u00f1ola](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=es&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[Deutsche](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=de&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[Svenska](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=sv&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[\ud55c\uad6d\uc5b4](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=ko&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[Fran\u00e7ais](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=fr&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[\u0939\u093f\u0928\u094d\u0926\u0940](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=hi&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[Portugu\u00eas](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=pt&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[Italian](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=it&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[\u0420\u0443\u0441\u0441\u043a\u0438\u0439](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=ru&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[Indonesian](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=id&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[\u0641\u0627\u0631\u0633\u06cc](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=fa&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[\u0639\u0631\u0628\u064a](https://github.com/rly0nheart/ipmap/blob/master/README_ar.md) \u2022\n[T\u00fcrk\u00e7e](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=tr&_x_tr_hl=en-US&_x_tr_pto=wapp) \u2022\n[Polskie](https://github-com.translate.goog/rly0nheart/ipmap/blob/master/README.md?_x_tr_sl=auto&_x_tr_tl=pl&_x_tr_hl=en-US&_x_tr_pto=wapp)\n\nIPMap geolocates a given ip address/addresses from a file, then generates a [leaflet](https://github.com/leaflet/leaflet) map pin-pointing the location of each ip address on it (with the right argument).\n\n# Features\n* Looks up ip address(es) and returns the associated information.\n* Looks up an ip address(es) and returns the associated information then pin points the location of the ip address(es) on a generated leaflet map.\n* Opens Google Earth on the location of the specified ip address(es).\n* Generated maps are saved to the `maps` directory in the user's home directory which is created on runtime if it does not exist.\n* Does not use external dependencies for the map, instead uses an already written html [map template](ipmap/data/templates/map.html).\n\n# Installation\n## PyPI\nIPMap can be installed from PyPI by running the following command in terminal/command prompt\n```\npip install ipmap\n```\n## GitHub\nOr if you prefer to install it from source, you can run the following command\n```\npip install git+https://github.com/rly0nheart/ipmap.git\n```\n## Build from source\n```Python\n# install poetry\npip install poetry\n\n# clone the project\ngit clone https://github.com/rly0nheart/ipmap\n\n# move to the ipmap directory\ncd ipmap\n\n# build the wheel file\npoetry build\n\n# install the built wheel (Linux)\npip install dist/*.whl\n\n# install built wheel (Windows)\npip install .\\dist\\generated-wheel-file-name.whl\n```\n\n# Usage\nTo see the usage, you can simply run\n```\nipmap --help\n```\nThe output should look like the following\n```\nusage: \n Geolocate IP Address(es) (with an interactive map)\n --------------------------------------------------\n ipmap <ip> --map\n\n Open Google Earth on the given coordinates\n --------------------------------------------\n ipmap <ip> --earth\n\n Lookup IP Address(es) (same as map but without an interactive map)\n ------------------------------------------------------------------\n ipmap <ip> --lookup\n \n\nIPMap (IP Mapper) \u2014 by Richard Mwewa (https://about.me/rly0nheart)\n\npositional arguments:\n ip target ip address\n\noptions:\n -h, --help show this help message and exit\n -e, --earth Open Google Earth on the location of a given ip\n -l, --lookup Lookup an ip (like --map, but without an interactive\n map)\n -m, --map Geolocate an ip (with an interactive map)\n -o OUTPUT, --output OUTPUT\n map output name (default ipmap)\n -v, --version show program's version number and exit\n\nA cross-platform easy-to-use ip geolocation & mapping tool.\n```\n> You can also pass a file containing ip addresses to `--ip`, IPMap will process the file accordingly and read each ip line by line.\n# Translations\n* [Justin Clark](https://github.com/jclark1913) - Added [README_ar.md](https://github.com/rly0nheart/ipmap/blob/master/README_ar.md) for Arabic translation\n> If you'd like to translate the project's README in any language, or if you can improve the (Google translated) translations of the already existing README's, feel free to open a pull request with your translations. I'd be more than happy to include them in the project :).\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A cross-platform easy-to-use ip geolocation & mapping tool.",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/rly0nheart/ipmap",
"Repository": "https://github.com/rly0nheart/ipmap"
},
"split_keywords": [
"mapping",
"geolocation",
"ip-address-geolocation",
"ip-address-lookup",
"ip-mapping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5d4cb327111bd4f77e17d9e71ae84465aeddd7c30b0cf741bdf175f44cdc0e6",
"md5": "26f965d723cf7e7d8b9ab6abacbdf659",
"sha256": "e0941fc0a0f490b52189f938500b7557d19a2018e7a06fa5aa90cb96160534ac"
},
"downloads": -1,
"filename": "ipmap-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26f965d723cf7e7d8b9ab6abacbdf659",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 11519,
"upload_time": "2023-06-26T00:49:27",
"upload_time_iso_8601": "2023-06-26T00:49:27.200774Z",
"url": "https://files.pythonhosted.org/packages/e5/d4/cb327111bd4f77e17d9e71ae84465aeddd7c30b0cf741bdf175f44cdc0e6/ipmap-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98e83da87c334cce51e92afee371787c89d54c8a2f91c16668e6d8aa4be2805d",
"md5": "bddd02416bbe512c87dfd1f911a03430",
"sha256": "46bb16020b672b862234b1b0002c73cd2238a6b7cff169f6bd575100814f16ec"
},
"downloads": -1,
"filename": "ipmap-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "bddd02416bbe512c87dfd1f911a03430",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 9820,
"upload_time": "2023-06-26T00:49:28",
"upload_time_iso_8601": "2023-06-26T00:49:28.579485Z",
"url": "https://files.pythonhosted.org/packages/98/e8/3da87c334cce51e92afee371787c89d54c8a2f91c16668e6d8aa4be2805d/ipmap-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-26 00:49:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rly0nheart",
"github_project": "ipmap",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ipmap"
}
JSON
