ipatel 0.1.0

A Python IP enrichment library

ENRICH IP (ipatel)

Overview

ipatel is a lightweight and efficient Python library and CLI tool for enriching IP addresses and ASNs with metadata such as:

• ASN (Autonomous System Number)
• Owner / AS Description
• Country Code
• IP Type (Public / Private / Invalid)
• IP Ranges for ASN

🔑 Features

• Works offline after downloading the IP-to-ASN database.
• Built-in support to auto-update the enrichment database.
• Friendly CLI with rich output formatting.
• Fully tested and modular codebase.

🚀 Quickstart Guide

Welcome to IPATEL — a fast and lightweight IP enrichment library.

This guide shows how to quickly get started with importing the library and using all core functions.

---

📦 Installation

pip install ipatel

---

✨ Basic Usage

import ipatel as ip

# Sample test inputs
test_ip = "8.8.8.8"
test_asn = 15169

---

🔍 IP Enrichment

Enrich an IP address with all available fields:

ip.enrich_ip(test_ip)

Returns:

{
    'ip': '8.8.8.8',
    'asn': 15169,
    'country_code': 'US',
    'owner': 'GOOGLE',
    'ip_type': 'Public'
}

---

🧠 ASN Lookups

Get ASN record (raw dict):

ip.get_record(test_ip)

Get ASN number:

ip.get_asn(test_ip)  # ➝ 15169

Get country code:

ip.get_country_code(test_ip)  # ➝ "US"

Get AS owner/organization:

ip.get_owner(test_ip)  # ➝ "GOOGLE"

Get all IP ranges owned by an ASN:

ip.get_ip_ranges_for_asn(test_asn)

---

🛠️ Utilities

Convert IP to integer:

ip.ip_to_int("8.8.8.8")  # ➝ 134744072

Convert integer to IP:

ip.int_to_ip(134744072)  # ➝ "8.8.8.8"

Detect IP type (public/private/reserved):

ip.get_ip_type("127.0.0.1")  # ➝ "Loopback"

---

🔄 Database Handling

Download the latest IP-to-ASN database:

ip.download_ip2asn_db()

Ensure local DB is fresh:

ip.ensure_ip2asn_db()

---

🧪 Full Test Script

You can try this all together:

def run_tests():
    ip.ensure_ip2asn_db()
    print(ip.enrich_ip("8.8.8.8"))

if __name__ == "__main__":
    run_tests()

---

📝 Notes

• All functions are safe for both IPv4 inputs.
• Private, reserved, and loopback IPs are handled gracefully.

---

📚 See Also

• CLI Usage
• Detailed API
• DB Upadte
• Project Repo