ipwhois-python 1.0.0__tar.gz → 1.0.1__tar.gz

ipwhois_python-1.0.1/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to `ipwhois-python` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1] - 2026-05-09
+
+### Changed
+
+- **Renamed the main class `Client` to `IPWhois`** for consistency with the
+  package and brand. The recommended import is now
+  `from ipwhois import IPWhois`. The source module moved from
+  `src/ipwhois/client.py` to `src/ipwhois/ipwhois.py`, and the test module
+  from `tests/test_client.py` to `tests/test_ipwhois.py`. Public behaviour,
+  method signatures, constructor arguments, and return shapes are all
+  unchanged.
+
+### Migration
+
+```python
+# Before (1.0.0):
+from ipwhois import Client
+client = Client("YOUR_API_KEY")
+info   = client.lookup("8.8.8.8")
+
+# After (1.0.1+):
+from ipwhois import IPWhois
+ipwhois = IPWhois("YOUR_API_KEY")
+info    = ipwhois.lookup("8.8.8.8")
+```
+
+The variable name (`client`, `ipwhois`, anything else) is up to you; only
+the class identifier changed.
+
+## [1.0.0] - 2026-05-08
+
+### Added
+
+- Initial release. 

{ipwhois_python-1.0.0 → ipwhois_python-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipwhois-python
-Version: 1.0.0
+Version: 1.0.1
 Summary: Official Python client for the ipwhois.io IP Geolocation API. Simple, dependency-free, supports single and bulk IP lookups.
 Project-URL: Homepage, https://ipwhois.io
 Project-URL: Documentation, https://ipwhois.io/documentation
@@ -53,9 +53,9 @@ Description-Content-Type: text/markdown
 
 # ipwhois-python
 
-[![PyPI Version](https://img.shields.io/pypi/v/ipwhois-python.svg)](https://pypi.org/project/ipwhois-python/)
-[![Python Versions](https://img.shields.io/pypi/pyversions/ipwhois-python.svg)](https://pypi.org/project/ipwhois-python/)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![PyPI Version](https://img.shields.io/pypi/v/ipwhois-python.svg?v=1)](https://pypi.org/project/ipwhois-python/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/ipwhois-python.svg?v=1)](https://pypi.org/project/ipwhois-python/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?v=1)](LICENSE)
 
 Official, dependency-free Python client for the [ipwhois.io](https://ipwhois.io) IP Geolocation API.
 
@@ -75,7 +75,7 @@ pip install ipwhois-python
 
 ## Free vs Paid plan
 
-The same `Client` class is used for both plans. The only difference is whether
+The same `IPWhois` class is used for both plans. The only difference is whether
 you pass an API key:
 
 - **Free plan** — create the client **without arguments**. No API key, no
@@ -85,10 +85,10 @@ you pass an API key:
   threat-detection data.
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
-free = Client()                 # Free plan — no API key
-paid = Client("YOUR_API_KEY")   # Paid plan — with API key
+free = IPWhois()                 # Free plan — no API key
+paid = IPWhois("YOUR_API_KEY")   # Paid plan — with API key
 ```
 
 Everything else (`lookup()`, options, error handling) is identical.
@@ -96,11 +96,11 @@ Everything else (`lookup()`, options, error handling) is identical.
 ## Quick start — Free plan (no API key)
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
-client = Client()  # no API key
+ipwhois = IPWhois()  # no API key
 
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 print(info["country"], info["flag"]["emoji"])
 # → United States 🇺🇸
@@ -114,11 +114,11 @@ print(f"{info['city']}, {info['region']}")
 Get an API key at <https://ipwhois.io> and pass it to the constructor:
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
-client = Client("YOUR_API_KEY")  # with API key
+ipwhois = IPWhois("YOUR_API_KEY")  # with API key
 
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 print(info["country"], info["flag"]["emoji"])
 # → United States 🇺🇸
@@ -127,7 +127,7 @@ print(f"{info['city']}, {info['region']}")
 # → Mountain View, California
 ```
 
-> ℹ️ Pass nothing to look up your own public IP: `client.lookup()` — works
+> ℹ️ Pass nothing to look up your own public IP: `ipwhois.lookup()` — works
 > on both plans.
 
 ## Lookup options
@@ -149,28 +149,28 @@ If you make many calls with the same options, set them once and forget:
 
 ```python
 # Free plan
-client = (
-    Client()
+ipwhois = (
+    IPWhois()
     .set_language("en")
     .set_fields(["country", "city", "flag.emoji"])
     .set_timeout(8)
 )
 
-client.lookup("8.8.8.8")                  # uses all of the above
-client.lookup("1.1.1.1", lang="de")       # per-call options override defaults
+ipwhois.lookup("8.8.8.8")                  # uses all of the above
+ipwhois.lookup("1.1.1.1", lang="de")       # per-call options override defaults
 ```
 
 ```python
 # Paid plan
-client = (
-    Client("YOUR_API_KEY")
+ipwhois = (
+    IPWhois("YOUR_API_KEY")
     .set_language("en")
     .set_fields(["country", "city", "flag.emoji"])
     .set_timeout(8)
 )
 
-client.lookup("8.8.8.8")                  # uses all of the above
-client.lookup("1.1.1.1", lang="de")       # per-call options override defaults
+ipwhois.lookup("8.8.8.8")                  # uses all of the above
+ipwhois.lookup("1.1.1.1", lang="de")       # per-call options override defaults
 ```
 
 > ℹ️ Paid plans additionally support `set_security(True)` (Business+) and
@@ -183,17 +183,17 @@ example, in environments without an up-to-date CA bundle), pass `ssl=False`
 to the constructor:
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
 # Free plan
-client = Client(ssl=False)
+ipwhois = IPWhois(ssl=False)
 ```
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
 # Paid plan
-client = Client("YOUR_API_KEY", ssl=False)
+ipwhois = IPWhois("YOUR_API_KEY", ssl=False)
 ```
 
 > ℹ️ HTTPS is strongly recommended for production traffic — your API key is
@@ -206,11 +206,11 @@ address counts as one credit. Available on the **Business** and **Unlimited**
 plans.
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
-client = Client("YOUR_API_KEY")
+ipwhois = IPWhois("YOUR_API_KEY")
 
-results = client.bulk_lookup([
+results = ipwhois.bulk_lookup([
     "8.8.8.8",
     "1.1.1.1",
     "208.67.222.222",
@@ -237,7 +237,7 @@ with `success` set to `False` and a `message`. Just check
 `info["success"]` after every call:
 
 ```python
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 if not info["success"]:
     print(f"Lookup failed: {info['message']}")
@@ -264,7 +264,7 @@ include extra fields you can branch on:
 ```python
 import time
 
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 if not info["success"]:
     if info.get("http_status") == 429:

{ipwhois_python-1.0.0 → ipwhois_python-1.0.1}/README.md

@@ -1,8 +1,8 @@
 # ipwhois-python
 
-[![PyPI Version](https://img.shields.io/pypi/v/ipwhois-python.svg)](https://pypi.org/project/ipwhois-python/)
-[![Python Versions](https://img.shields.io/pypi/pyversions/ipwhois-python.svg)](https://pypi.org/project/ipwhois-python/)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![PyPI Version](https://img.shields.io/pypi/v/ipwhois-python.svg?v=1)](https://pypi.org/project/ipwhois-python/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/ipwhois-python.svg?v=1)](https://pypi.org/project/ipwhois-python/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?v=1)](LICENSE)
 
 Official, dependency-free Python client for the [ipwhois.io](https://ipwhois.io) IP Geolocation API.
 
@@ -22,7 +22,7 @@ pip install ipwhois-python
 
 ## Free vs Paid plan
 
-The same `Client` class is used for both plans. The only difference is whether
+The same `IPWhois` class is used for both plans. The only difference is whether
 you pass an API key:
 
 - **Free plan** — create the client **without arguments**. No API key, no
@@ -32,10 +32,10 @@ you pass an API key:
   threat-detection data.
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
-free = Client()                 # Free plan — no API key
-paid = Client("YOUR_API_KEY")   # Paid plan — with API key
+free = IPWhois()                 # Free plan — no API key
+paid = IPWhois("YOUR_API_KEY")   # Paid plan — with API key
 ```
 
 Everything else (`lookup()`, options, error handling) is identical.
@@ -43,11 +43,11 @@ Everything else (`lookup()`, options, error handling) is identical.
 ## Quick start — Free plan (no API key)
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
-client = Client()  # no API key
+ipwhois = IPWhois()  # no API key
 
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 print(info["country"], info["flag"]["emoji"])
 # → United States 🇺🇸
@@ -61,11 +61,11 @@ print(f"{info['city']}, {info['region']}")
 Get an API key at <https://ipwhois.io> and pass it to the constructor:
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
-client = Client("YOUR_API_KEY")  # with API key
+ipwhois = IPWhois("YOUR_API_KEY")  # with API key
 
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 print(info["country"], info["flag"]["emoji"])
 # → United States 🇺🇸
@@ -74,7 +74,7 @@ print(f"{info['city']}, {info['region']}")
 # → Mountain View, California
 ```
 
-> ℹ️ Pass nothing to look up your own public IP: `client.lookup()` — works
+> ℹ️ Pass nothing to look up your own public IP: `ipwhois.lookup()` — works
 > on both plans.
 
 ## Lookup options
@@ -96,28 +96,28 @@ If you make many calls with the same options, set them once and forget:
 
 ```python
 # Free plan
-client = (
-    Client()
+ipwhois = (
+    IPWhois()
     .set_language("en")
     .set_fields(["country", "city", "flag.emoji"])
     .set_timeout(8)
 )
 
-client.lookup("8.8.8.8")                  # uses all of the above
-client.lookup("1.1.1.1", lang="de")       # per-call options override defaults
+ipwhois.lookup("8.8.8.8")                  # uses all of the above
+ipwhois.lookup("1.1.1.1", lang="de")       # per-call options override defaults
 ```
 
 ```python
 # Paid plan
-client = (
-    Client("YOUR_API_KEY")
+ipwhois = (
+    IPWhois("YOUR_API_KEY")
     .set_language("en")
     .set_fields(["country", "city", "flag.emoji"])
     .set_timeout(8)
 )
 
-client.lookup("8.8.8.8")                  # uses all of the above
-client.lookup("1.1.1.1", lang="de")       # per-call options override defaults
+ipwhois.lookup("8.8.8.8")                  # uses all of the above
+ipwhois.lookup("1.1.1.1", lang="de")       # per-call options override defaults
 ```
 
 > ℹ️ Paid plans additionally support `set_security(True)` (Business+) and
@@ -130,17 +130,17 @@ example, in environments without an up-to-date CA bundle), pass `ssl=False`
 to the constructor:
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
 # Free plan
-client = Client(ssl=False)
+ipwhois = IPWhois(ssl=False)
 ```
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
 # Paid plan
-client = Client("YOUR_API_KEY", ssl=False)
+ipwhois = IPWhois("YOUR_API_KEY", ssl=False)
 ```
 
 > ℹ️ HTTPS is strongly recommended for production traffic — your API key is
@@ -153,11 +153,11 @@ address counts as one credit. Available on the **Business** and **Unlimited**
 plans.
 
 ```python
-from ipwhois import Client
+from ipwhois import IPWhois
 
-client = Client("YOUR_API_KEY")
+ipwhois = IPWhois("YOUR_API_KEY")
 
-results = client.bulk_lookup([
+results = ipwhois.bulk_lookup([
     "8.8.8.8",
     "1.1.1.1",
     "208.67.222.222",
@@ -184,7 +184,7 @@ with `success` set to `False` and a `message`. Just check
 `info["success"]` after every call:
 
 ```python
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 if not info["success"]:
     print(f"Lookup failed: {info['message']}")
@@ -211,7 +211,7 @@ include extra fields you can branch on:
 ```python
 import time
 
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 if not info["success"]:
     if info.get("http_status") == 429:

{ipwhois_python-1.0.0 → ipwhois_python-1.0.1}/examples/basic.py

@@ -4,15 +4,15 @@ from __future__ import annotations
 
 import sys
 
-from ipwhois import Client
+from ipwhois import IPWhois
 
 
 # -----------------------------------------------------------------------
 # 1) Free plan -- no API key, ~1 request/second per client IP.
 # -----------------------------------------------------------------------
-client = Client()
+ipwhois = IPWhois()
 
-info = client.lookup("8.8.8.8")
+info = ipwhois.lookup("8.8.8.8")
 
 # All errors -- invalid IP, network failure, bad options, ... -- come back
 # here with success == False. The library never raises.
@@ -33,7 +33,7 @@ print(
 # -----------------------------------------------------------------------
 # 2) Look up the caller's own IP -- pass nothing (or None).
 # -----------------------------------------------------------------------
-me = client.lookup()
+me = ipwhois.lookup()
 if me["success"]:
     print(f"My IP: {me['ip']} -- {me['country']}")
 
@@ -41,7 +41,7 @@ if me["success"]:
 # -----------------------------------------------------------------------
 # 3) Paid plan -- supply the API key.
 # -----------------------------------------------------------------------
-paid = Client("YOUR_API_KEY")
+paid = IPWhois("YOUR_API_KEY")
 
 info = paid.lookup(
     "1.1.1.1",

{ipwhois_python-1.0.0 → ipwhois_python-1.0.1}/examples/bulk.py

@@ -13,10 +13,10 @@ from __future__ import annotations
 
 import sys
 
-from ipwhois import Client
+from ipwhois import IPWhois
 
 
-client = Client("YOUR_API_KEY")
+ipwhois = IPWhois("YOUR_API_KEY")
 
 ips = [
     "8.8.8.8",
@@ -25,7 +25,7 @@ ips = [
     "2c0f:fb50:4003::",     # IPv6 is fine too -- mix freely
 ]
 
-results = client.bulk_lookup(ips, lang="en", security=True)
+results = ipwhois.bulk_lookup(ips, lang="en", security=True)
 
 # Whole-batch failure (network down, bad API key, rate limit, ...) -- the
 # response is a single error dict instead of a list of per-IP results.

{ipwhois_python-1.0.0 → ipwhois_python-1.0.1}/examples/defaults.py

@@ -8,11 +8,11 @@ from __future__ import annotations
 
 import sys
 
-from ipwhois import Client
+from ipwhois import IPWhois
 
 
-client = (
-    Client("YOUR_API_KEY")
+ipwhois = (
+    IPWhois("YOUR_API_KEY")
     .set_language("en")
     .set_fields(["country", "city", "flag.emoji", "connection.isp"])
     .set_security(True)
@@ -30,12 +30,12 @@ def show(label: str, info: dict) -> None:
 
 
 # Both calls below will use lang=en, the field whitelist, and security=1.
-google = client.lookup("8.8.8.8")
-cf     = client.lookup("1.1.1.1")
+google = ipwhois.lookup("8.8.8.8")
+cf     = ipwhois.lookup("1.1.1.1")
 
 show("8.8.8.8", google)
 show("1.1.1.1", cf)
 
 # One-off override -- this single call uses German instead of English.
-de_only = client.lookup("8.8.4.4", lang="de")
+de_only = ipwhois.lookup("8.8.4.4", lang="de")
 show("8.8.4.4 (de)", de_only)

{ipwhois_python-1.0.0 → ipwhois_python-1.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ipwhois-python"
-version = "1.0.0"
+version = "1.0.1"
 description = "Official Python client for the ipwhois.io IP Geolocation API. Simple, dependency-free, supports single and bulk IP lookups."
 readme = "README.md"
 license = { file = "LICENSE" }

ipwhois_python-1.0.1/src/ipwhois/__init__.py

@@ -0,0 +1,11 @@
+"""Official Python client for the ipwhois.io IP Geolocation API.
+
+See :class:`ipwhois.IPWhois` for usage. The library never raises -- every
+failure comes back inside the response dict with ``success`` set to ``False``
+and a ``message``.
+"""
+
+from .ipwhois import IPWhois
+
+__all__ = ["IPWhois", "__version__"]
+__version__ = IPWhois.VERSION

ipwhois_python-1.0.0/src/ipwhois/client.py → ipwhois_python-1.0.1/src/ipwhois/ipwhois.py

@@ -2,16 +2,18 @@
 
 Quick start
 -----------
+    from ipwhois import IPWhois
+
     # Free plan (no API key, ~1 request/second per client IP)
-    client = ipwhois.Client()
-    info   = client.lookup("8.8.8.8")
+    ipwhois = IPWhois()
+    info    = ipwhois.lookup("8.8.8.8")
 
     # Paid plan (with API key, higher limits, bulk, security data, ...)
-    client = ipwhois.Client("YOUR_API_KEY")
-    info   = client.lookup("8.8.8.8", lang="en", security=True)
+    ipwhois = IPWhois("YOUR_API_KEY")
+    info    = ipwhois.lookup("8.8.8.8", lang="en", security=True)
 
     # Bulk lookup -- up to 100 IPs in one call (paid only)
-    rows = client.bulk_lookup(["8.8.8.8", "1.1.1.1", "208.67.222.222"])
+    rows = ipwhois.bulk_lookup(["8.8.8.8", "1.1.1.1", "208.67.222.222"])
 
     # HTTPS is enabled by default. Pass ssl=False to fall back to HTTP.
 
@@ -32,7 +34,7 @@ import urllib.parse
 import urllib.request
 from typing import Any, Dict, Iterable, List, Optional, Union
 
-__all__ = ["Client"]
+__all__ = ["IPWhois"]
 
 # Public type alias: a single API response (lookup or whole-batch error).
 Response = Dict[str, Any]
@@ -40,7 +42,7 @@ Response = Dict[str, Any]
 BulkResponse = Union[List[Response], Response]
 
 
-class Client:
+class IPWhois:
     """Client for the ipwhois.io IP Geolocation API.
 
     The same class is used for both the Free and Paid plans -- the only
@@ -53,7 +55,7 @@ class Client:
     """
 
     #: Library version, used in the default User-Agent header.
-    VERSION: str = "1.0.0"
+    VERSION: str = "1.0.1"
 
     #: Free-plan endpoint host (used when no API key is provided).
     HOST_FREE: str = "ipwho.is"
@@ -217,7 +219,7 @@ class Client:
 
     # -- Fluent setters ------------------------------------------------- #
 
-    def set_language(self, lang: str) -> "Client":
+    def set_language(self, lang: str) -> "IPWhois":
         """Set the default language used when none is supplied per call.
 
         :param lang: One of :attr:`SUPPORTED_LANGUAGES`.
@@ -227,7 +229,7 @@ class Client:
 
     def set_fields(
         self, fields: Union[str, Iterable[str], None]
-    ) -> "Client":
+    ) -> "IPWhois":
         """Restrict every response to a fixed set of fields by default.
 
         :param fields: An iterable of field names, e.g.
@@ -251,17 +253,17 @@ class Client:
                 self._defaults["fields"] = str(fields)
         return self
 
-    def set_security(self, enabled: bool) -> "Client":
+    def set_security(self, enabled: bool) -> "IPWhois":
         """Enable or disable threat-detection data on every call by default."""
         self._defaults["security"] = bool(enabled)
         return self
 
-    def set_rate(self, enabled: bool) -> "Client":
+    def set_rate(self, enabled: bool) -> "IPWhois":
         """Enable or disable the ``rate`` block in responses by default."""
         self._defaults["rate"] = bool(enabled)
         return self
 
-    def set_timeout(self, seconds: Any) -> "Client":
+    def set_timeout(self, seconds: Any) -> "IPWhois":
         """Set the per-request total timeout in seconds (default: 10).
 
         Bad values (non-numeric, negative) silently fall back to the default,
@@ -270,7 +272,7 @@ class Client:
         self._timeout = _coerce_positive_int(seconds, self._timeout)
         return self
 
-    def set_connect_timeout(self, seconds: Any) -> "Client":
+    def set_connect_timeout(self, seconds: Any) -> "IPWhois":
         """Set the connection timeout in seconds (default: 5).
 
         Note: Python's :mod:`urllib` exposes a single timeout that covers
@@ -287,7 +289,7 @@ class Client:
         )
         return self
 
-    def set_user_agent(self, user_agent: str) -> "Client":
+    def set_user_agent(self, user_agent: str) -> "IPWhois":
         """Override the User-Agent header sent with every request."""
         self._user_agent = str(user_agent)
         return self
@@ -502,7 +504,7 @@ def _coerce_positive_int(value: Any, default: int) -> int:
     """Coerce ``value`` to a positive int, falling back to ``default``.
 
     Mirrors PHP's lenient ``(int)`` cast so that a stray ``"foo"`` passed
-    via constructor kwargs or :meth:`Client.set_timeout` doesn't blow up
+    via constructor kwargs or :meth:`IPWhois.set_timeout` doesn't blow up
     the whole client. ``None``, non-numeric strings, ``True``/``False``
     edge cases, negative numbers and zero all map to ``default``.
     """

ipwhois_python-1.0.0/tests/test_client.py → ipwhois_python-1.0.1/tests/test_ipwhois.py

@@ -6,34 +6,34 @@ the suite can be run anywhere without an API key or network access.
 
 from __future__ import annotations
 
-from ipwhois import Client
+from ipwhois import IPWhois
 
 
-def _build_url(client: Client, path: str, **options) -> str:
-    return client._build_url(path, options)
+def _build_url(ipwhois: IPWhois, path: str, **options) -> str:
+    return ipwhois._build_url(path, options)
 
 
 def test_free_endpoint_has_no_api_key() -> None:
-    client = Client()
-    assert _build_url(client, "/8.8.8.8") == "https://ipwho.is/8.8.8.8"
+    ipwhois = IPWhois()
+    assert _build_url(ipwhois, "/8.8.8.8") == "https://ipwho.is/8.8.8.8"
 
 
 def test_paid_endpoint_appends_api_key() -> None:
-    client = Client("TESTKEY")
-    url = _build_url(client, "/8.8.8.8")
+    ipwhois = IPWhois("TESTKEY")
+    url = _build_url(ipwhois, "/8.8.8.8")
 
     assert url.startswith("https://ipwhois.pro/8.8.8.8?")
     assert "key=TESTKEY" in url
 
 
 def test_https_is_always_used_by_default() -> None:
-    assert _build_url(Client(), "/").startswith("https://")
-    assert _build_url(Client("K"), "/").startswith("https://")
+    assert _build_url(IPWhois(), "/").startswith("https://")
+    assert _build_url(IPWhois("K"), "/").startswith("https://")
 
 
 def test_ssl_can_be_disabled() -> None:
-    free = Client(ssl=False)
-    paid = Client("K", ssl=False)
+    free = IPWhois(ssl=False)
+    paid = IPWhois("K", ssl=False)
 
     assert _build_url(free, "/").startswith("http://ipwho.is")
     assert _build_url(paid, "/").startswith("http://ipwhois.pro")
@@ -41,13 +41,13 @@ def test_ssl_can_be_disabled() -> None:
 
 def test_ssl_defaults_to_true_when_not_passed() -> None:
     # Sanity check: omitting the option keeps HTTPS on.
-    assert _build_url(Client("K"), "/").startswith("https://")
+    assert _build_url(IPWhois("K"), "/").startswith("https://")
 
 
 def test_fields_are_joined_with_commas() -> None:
-    client = Client("K")
+    ipwhois = IPWhois("K")
     url = _build_url(
-        client, "/8.8.8.8", fields=["country", "city", "flag.emoji"]
+        ipwhois, "/8.8.8.8", fields=["country", "city", "flag.emoji"]
     )
 
     # urlencode encodes commas as %2C -- both forms are valid HTTP.
@@ -55,36 +55,36 @@ def test_fields_are_joined_with_commas() -> None:
 
 
 def test_fields_accepts_a_string_too() -> None:
-    client = Client("K")
-    url = _build_url(client, "/8.8.8.8", fields="country,city")
+    ipwhois = IPWhois("K")
+    url = _build_url(ipwhois, "/8.8.8.8", fields="country,city")
     assert "fields=country%2Ccity" in url
 
 
 def test_security_and_rate_are_flags_not_values() -> None:
-    client = Client("K")
-    url = _build_url(client, "/", security=True, rate=True)
+    ipwhois = IPWhois("K")
+    url = _build_url(ipwhois, "/", security=True, rate=True)
 
     assert "security=1" in url
     assert "rate=1" in url
 
 
 def test_security_false_is_omitted() -> None:
-    client = Client("K")
-    url = _build_url(client, "/", security=False)
+    ipwhois = IPWhois("K")
+    url = _build_url(ipwhois, "/", security=False)
 
     assert "security=" not in url
 
 
 def test_per_call_options_override_defaults() -> None:
-    client = Client("K", lang="ru")
-    url = _build_url(client, "/", lang="en")
+    ipwhois = IPWhois("K", lang="ru")
+    url = _build_url(ipwhois, "/", lang="en")
 
     assert "lang=en" in url
     assert "lang=ru" not in url
 
 
 def test_invalid_language_returns_error_dict() -> None:
-    result = Client().lookup("8.8.8.8", lang="klingon")
+    result = IPWhois().lookup("8.8.8.8", lang="klingon")
 
     assert result["success"] is False
     assert result.get("error_type") == "invalid_argument"
@@ -92,7 +92,7 @@ def test_invalid_language_returns_error_dict() -> None:
 
 
 def test_invalid_output_returns_error_dict() -> None:
-    result = Client().lookup("8.8.8.8", output="yaml")
+    result = IPWhois().lookup("8.8.8.8", output="yaml")
 
     assert result["success"] is False
     assert result.get("error_type") == "invalid_argument"
@@ -100,7 +100,7 @@ def test_invalid_output_returns_error_dict() -> None:
 
 
 def test_bulk_lookup_refuses_empty_list() -> None:
-    result = Client("K").bulk_lookup([])
+    result = IPWhois("K").bulk_lookup([])
 
     assert isinstance(result, dict)
     assert result["success"] is False
@@ -108,8 +108,8 @@ def test_bulk_lookup_refuses_empty_list() -> None:
 
 
 def test_bulk_lookup_refuses_more_than_limit() -> None:
-    too_many = ["8.8.8.8"] * (Client.BULK_LIMIT + 1)
-    result = Client("K").bulk_lookup(too_many)
+    too_many = ["8.8.8.8"] * (IPWhois.BULK_LIMIT + 1)
+    result = IPWhois("K").bulk_lookup(too_many)
 
     assert isinstance(result, dict)
     assert result["success"] is False
@@ -117,60 +117,60 @@ def test_bulk_lookup_refuses_more_than_limit() -> None:
 
 
 def test_bulk_url_is_comma_separated() -> None:
-    client = Client("K")
-    url = _build_url(client, "/bulk/" + ",".join(["8.8.8.8", "1.1.1.1"]))
+    ipwhois = IPWhois("K")
+    url = _build_url(ipwhois, "/bulk/" + ",".join(["8.8.8.8", "1.1.1.1"]))
 
     assert "/bulk/8.8.8.8,1.1.1.1" in url
 
 
 def test_fluent_setters_return_self() -> None:
-    client = Client()
+    ipwhois = IPWhois()
 
-    assert client.set_language("en") is client
-    assert client.set_fields(["country"]) is client
-    assert client.set_security(True) is client
-    assert client.set_rate(False) is client
-    assert client.set_timeout(5) is client
-    assert client.set_connect_timeout(2) is client
-    assert client.set_user_agent("test/1.0") is client
+    assert ipwhois.set_language("en") is ipwhois
+    assert ipwhois.set_fields(["country"]) is ipwhois
+    assert ipwhois.set_security(True) is ipwhois
+    assert ipwhois.set_rate(False) is ipwhois
+    assert ipwhois.set_timeout(5) is ipwhois
+    assert ipwhois.set_connect_timeout(2) is ipwhois
+    assert ipwhois.set_user_agent("test/1.0") is ipwhois
 
 
 def test_set_language_affects_subsequent_requests() -> None:
-    client = Client("K").set_language("de")
-    url = _build_url(client, "/")
+    ipwhois = IPWhois("K").set_language("de")
+    url = _build_url(ipwhois, "/")
 
     assert "lang=de" in url
 
 
 def test_set_fields_affects_subsequent_requests() -> None:
-    client = Client("K").set_fields(["country", "city"])
-    url = _build_url(client, "/8.8.8.8")
+    ipwhois = IPWhois("K").set_fields(["country", "city"])
+    url = _build_url(ipwhois, "/8.8.8.8")
 
     assert "fields=country%2Ccity" in url
 
 
 def test_constructor_options_become_defaults() -> None:
-    client = Client("K", lang="ru", security=True)
-    url = _build_url(client, "/8.8.8.8")
+    ipwhois = IPWhois("K", lang="ru", security=True)
+    url = _build_url(ipwhois, "/8.8.8.8")
 
     assert "lang=ru" in url
     assert "security=1" in url
 
 
 def test_user_agent_can_be_set_in_constructor() -> None:
-    client = Client(user_agent="my-app/2.0")
-    assert client._user_agent == "my-app/2.0"
+    ipwhois = IPWhois(user_agent="my-app/2.0")
+    assert ipwhois._user_agent == "my-app/2.0"
 
 
 def test_default_user_agent_includes_version() -> None:
-    client = Client()
-    assert client._user_agent == f"ipwhois-python/{Client.VERSION}"
+    ipwhois = IPWhois()
+    assert ipwhois._user_agent == f"ipwhois-python/{IPWhois.VERSION}"
 
 
 def test_ip_is_url_encoded_for_ipv6() -> None:
     # IPv6 colons must be percent-encoded inside a path segment.
-    client = Client()
-    url = _build_url(client, "/" + __import__("urllib.parse", fromlist=["quote"]).quote("2c0f:fb50:4003::", safe=""))
+    ipwhois = IPWhois()
+    url = _build_url(ipwhois, "/" + __import__("urllib.parse", fromlist=["quote"]).quote("2c0f:fb50:4003::", safe=""))
     assert "%3A" in url
 
 
@@ -182,7 +182,7 @@ def test_ip_is_url_encoded_for_ipv6() -> None:
 def test_bulk_lookup_rejects_a_single_string() -> None:
     # Strings are iterable in Python; without the guard, "8.8.8.8" would
     # be looked up character-by-character. Reject explicitly.
-    result = Client("K").bulk_lookup("8.8.8.8")  # type: ignore[arg-type]
+    result = IPWhois("K").bulk_lookup("8.8.8.8")  # type: ignore[arg-type]
 
     assert isinstance(result, dict)
     assert result["success"] is False
@@ -191,7 +191,7 @@ def test_bulk_lookup_rejects_a_single_string() -> None:
 
 
 def test_bulk_lookup_rejects_bytes() -> None:
-    result = Client("K").bulk_lookup(b"8.8.8.8")  # type: ignore[arg-type]
+    result = IPWhois("K").bulk_lookup(b"8.8.8.8")  # type: ignore[arg-type]
 
     assert isinstance(result, dict)
     assert result["success"] is False
@@ -199,7 +199,7 @@ def test_bulk_lookup_rejects_bytes() -> None:
 
 
 def test_bulk_lookup_handles_none_gracefully() -> None:
-    result = Client("K").bulk_lookup(None)  # type: ignore[arg-type]
+    result = IPWhois("K").bulk_lookup(None)  # type: ignore[arg-type]
 
     assert isinstance(result, dict)
     assert result["success"] is False
@@ -207,7 +207,7 @@ def test_bulk_lookup_handles_none_gracefully() -> None:
 
 
 def test_bulk_lookup_handles_non_iterable_gracefully() -> None:
-    result = Client("K").bulk_lookup(42)  # type: ignore[arg-type]
+    result = IPWhois("K").bulk_lookup(42)  # type: ignore[arg-type]
 
     assert isinstance(result, dict)
     assert result["success"] is False
@@ -215,14 +215,14 @@ def test_bulk_lookup_handles_non_iterable_gracefully() -> None:
 
 
 def test_bulk_lookup_accepts_a_generator() -> None:
-    client = Client("K")
+    ipwhois = IPWhois("K")
     # A generator is an iterable that's not a list -- make sure it works.
     gen = (ip for ip in ["8.8.8.8", "1.1.1.1"])
     # Just check it gets through validation -- we don't actually hit the
     # network. Validation passes if we don't get an `error_type` back.
     # We trigger the guard *before* network by passing an empty generator:
     empty = (x for x in [])
-    result = client.bulk_lookup(empty)
+    result = ipwhois.bulk_lookup(empty)
     assert isinstance(result, dict)
     assert result["success"] is False
     assert result.get("error_type") == "invalid_argument"
@@ -233,8 +233,8 @@ def test_bulk_lookup_accepts_a_generator() -> None:
 
 def test_set_fields_keeps_string_intact() -> None:
     # Without the str guard, list("country,city") explodes into characters.
-    client = Client("K").set_fields("country,city")
-    url = _build_url(client, "/8.8.8.8")
+    ipwhois = IPWhois("K").set_fields("country,city")
+    url = _build_url(ipwhois, "/8.8.8.8")
 
     assert "fields=country%2Ccity" in url
     # Sanity: confirm we haven't accidentally produced the broken form.
@@ -243,58 +243,58 @@ def test_set_fields_keeps_string_intact() -> None:
 
 def test_set_fields_tolerates_none() -> None:
     # set_fields(None) must not raise; it clears any previously-set default.
-    client = Client().set_fields(["country"]).set_fields(None)
-    url = client._build_url("/8.8.8.8", {})
+    ipwhois = IPWhois().set_fields(["country"]).set_fields(None)
+    url = ipwhois._build_url("/8.8.8.8", {})
     assert "fields=" not in url
 
 
 def test_set_fields_tolerates_non_iterable() -> None:
     # Non-iterable, non-string garbage falls back to str() rather than raising.
-    client = Client("K").set_fields(42)  # type: ignore[arg-type]
-    url = _build_url(client, "/8.8.8.8")
+    ipwhois = IPWhois("K").set_fields(42)  # type: ignore[arg-type]
+    url = _build_url(ipwhois, "/8.8.8.8")
     assert "fields=42" in url
 
 
 def test_set_timeout_tolerates_garbage_input() -> None:
     # "never raises" extends to setters: bad input falls back to previous
     # value rather than raising ValueError.
-    client = Client()
-    previous = client._timeout
+    ipwhois = IPWhois()
+    previous = ipwhois._timeout
 
-    client.set_timeout("not a number")  # type: ignore[arg-type]
-    assert client._timeout == previous
+    ipwhois.set_timeout("not a number")  # type: ignore[arg-type]
+    assert ipwhois._timeout == previous
 
-    client.set_timeout(None)  # type: ignore[arg-type]
-    assert client._timeout == previous
+    ipwhois.set_timeout(None)  # type: ignore[arg-type]
+    assert ipwhois._timeout == previous
 
-    client.set_timeout(-5)
-    assert client._timeout == previous
+    ipwhois.set_timeout(-5)
+    assert ipwhois._timeout == previous
 
     # Numeric strings are accepted (matches PHP's `(int)` behaviour).
-    client.set_timeout("15")  # type: ignore[arg-type]
-    assert client._timeout == 15
+    ipwhois.set_timeout("15")  # type: ignore[arg-type]
+    assert ipwhois._timeout == 15
 
 
 def test_set_connect_timeout_tolerates_garbage_input() -> None:
-    client = Client()
-    previous = client._connect_timeout
+    ipwhois = IPWhois()
+    previous = ipwhois._connect_timeout
 
-    client.set_connect_timeout("oops")  # type: ignore[arg-type]
-    assert client._connect_timeout == previous
+    ipwhois.set_connect_timeout("oops")  # type: ignore[arg-type]
+    assert ipwhois._connect_timeout == previous
 
 
 def test_constructor_tolerates_bad_timeout() -> None:
     # Constructor garbage values fall back to defaults instead of raising.
-    client = Client(timeout="not-a-number", connect_timeout=None)
-    assert client._timeout == 10
-    assert client._connect_timeout == 5
+    ipwhois = IPWhois(timeout="not-a-number", connect_timeout=None)
+    assert ipwhois._timeout == 10
+    assert ipwhois._connect_timeout == 5
 
 
 def test_raw_response_includes_success_true() -> None:
     # When the API returns non-JSON (output=xml/csv), the wrapper response
     # must include `success: True` so the documented `if info["success"]`
     # check from the README still works.
-    client = Client()
+    ipwhois = IPWhois()
 
     # Simulate the parsing branch by calling the JSON-decode path with
     # non-JSON input via a tiny direct test of the internal helper:
@@ -323,7 +323,7 @@ def test_raw_response_includes_success_true() -> None:
 
     fake = _FakeResp(b"<xml><ip>8.8.8.8</ip></xml>")
     with patch("urllib.request.urlopen", return_value=fake):
-        result = client.lookup("8.8.8.8", output="xml")
+        result = ipwhois.lookup("8.8.8.8", output="xml")
 
     assert result["success"] is True
     assert result["raw"] == "<xml><ip>8.8.8.8</ip></xml>"

ipwhois_python-1.0.0/CHANGELOG.md

@@ -1,12 +0,0 @@
-# Changelog
-
-All notable changes to `ipwhois-python` will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.0.0] - 2026-05-08
-
-### Added
-
-- Initial release. 

ipwhois_python-1.0.0/src/ipwhois/__init__.py

@@ -1,11 +0,0 @@
-"""Official Python client for the ipwhois.io IP Geolocation API.
-
-See :class:`ipwhois.Client` for usage. The library never raises -- every
-failure comes back inside the response dict with ``success`` set to ``False``
-and a ``message``.
-"""
-
-from .client import Client
-
-__all__ = ["Client", "__version__"]
-__version__ = Client.VERSION