Skip to main content

A better way to use IP2Location in Python

Project description

EasyI2L - Easy IP2Location Wrapper

easyi2l is a Python wrapper around the IP2LOCATION library. It allows you to automatically download and load the IP2LOCATION database, simplifying the process of working with IP geolocation data.

Features

  • Automatic Download: Fetches the IP2LOCATION database directly using your IP2LOCATION token.
  • Database Loading: Automatically loads the downloaded database for immediate use.
  • Simple API: Retrieve IP geolocation data with minimal setup.

Installation

Install the package via pip:

pip install easyi2l

Usage

Before using the package, ensure you have the IP2LOCATION_TOKEN environment variable set. You can obtain a token from IP2Location LITE.

Example

Here's a simple example of how to use easyi2l:

from easyi2l import EasyI2L, DBType


db = EasyI2L.download(DBType.DB11LITEBIN).load()

# Retrieve all data for an IP address
print(db.get_all("1.1.1.1"))

Environment Setup

You need to set the IP2LOCATION_TOKEN environment variable for the package to function correctly. The package uses load_dotenv from the dotenv module to load this variable from a .env file in your working directory.

Create a .env file with the following content:

IP2LOCATION_TOKEN=your_token_here

Contributing

Feel free to open issues or submit pull requests to improve the library.

License

This project is licensed under the MIT License.

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

easyi2l-0.0.1.tar.gz (4.3 kB view hashes)

Uploaded Source

Built Distribution

easyi2l-0.0.1-py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 3

Supported by

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