Skip to main content

A cross-platform easy-to-use ip geolocation & mapping tool.

Project description

Docker Image CI CodeQL GitHub top language PyPI PyPI - Status

English readme简体中文 readme正體中文 readmeLengua española readmeDeutsche readmeSvenska readme한국어 readmeFrançais readmeहिन्दी readmePortuguês readmeItalian readmeРусский readmeIndonesian readmeفارسی readmeعربي readmeTürkçe readmePolskie readme

IPMap geolocates a given ip address/addresses from a file, then generates a 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.

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

# 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 map --ip <ip>

    Open Google Earth on the given coordinates
    --------------------------------------------
    ipmap earth --ip <ip>

    Lookup IP Address(es) (same as map but without an interactive map)
    ------------------------------------------------------------------
    ipmap lookup --ip <ip>

modes:
    map - creates an interactive map and pin points the locations of the specified ip address(es) on it.
    earth - opens google earth on the location of the given ip address.
    lookup - looks up the specified ip address(es)' information.


IPMap (IP Mapper) — by Richard Mwewa (https://about.me/rly0nheart)

positional arguments:
  {earth,lookup,map}    init mode

options:
  -h, --help            show this help message and exit
  -i IP, --ip IP        ip
  -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

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 :).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipmap-1.1.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

ipmap-1.1.0-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file ipmap-1.1.0.tar.gz.

File metadata

  • Download URL: ipmap-1.1.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for ipmap-1.1.0.tar.gz
Algorithm Hash digest
SHA256 59cf1bdb857ec606e7b0bb8ce211cd5e1a1382f53c011d37ba2483bbf9a3efdc
MD5 442b25726ff60d6672c65754895872fe
BLAKE2b-256 84ee6853807bbe2ada5ee81f46d675d738c9700a3de27b80ccd42f435e9fbfc4

See more details on using hashes here.

File details

Details for the file ipmap-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: ipmap-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for ipmap-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bf0f18fc73b834bcd2bdbed98871e476acbc4d030e12dfaea53ce884e3fdbb4b
MD5 8bba4e050e577fcba6adcfec5ccf1fc9
BLAKE2b-256 8a50aba1af47963883b2f730fd348c13730fe7907b3b13115137a8f1c23bb3c6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page