fix(pypi): rename pacakge name

Author: gfpcom

README.md

@@ -1,81 +1,96 @@
-GetFreeProxy Python client
-=================================
+GetFreeProxy — Python client
+===========================
 
-Install
--------
+This is a small, typed Python client for the GetFreeProxy API (https://developer.getfreeproxy.com).
+
+About the API
+-------------
+The GetFreeProxy API exposes a simple endpoint to fetch public proxy servers:
+
+- GET /v1/proxies — returns a JSON array of proxy objects. Optional query parameters include `country`, `protocol`, and `page`.
+
+Each proxy object contains fields such as `ip`, `port`, `protocol`, `proxyUrl`, `countryCode`, `anonymity`, `uptime`, and timestamps like `lastAliveAt`.
+
+Key behaviours of this client
+----------------------------
+- Minimal runtime dependency (`httpx`).
+- Synchronous `Client` and asynchronous `AsyncClient` classes with simple `query(...)` methods.
+- Returns a list of `Proxy` dataclasses (fields mapped to Pythonic names, e.g. `country_code`).
+- Raises typed exceptions on errors: `APIError`, `InvalidAPIKey`, `NetworkError`, `TimeoutError`, `ParseError`.
+
+Installation
+------------
+
+Install from PyPI (when published) or locally in editable mode during development:
 
 ```bash
-pip install .
+pip install freeproxy-python
+# or local editable install for development:
+pip install -e .[dev]
 ```
 
-Usage (sync)
-------------
+Quick examples
+--------------
+
+Sync example:
 
 ```py
-from getfreeproxy import FreeProxyClient
+from freeproxy import Client
 
-client = FreeProxyClient(api_key="YOUR_API_KEY")
+client = Client(api_key="YOUR_API_KEY")
 proxies = client.query(country="US", protocol="https")
 for p in proxies:
-    print(p.proxy_url)
+    print(p.to_url())
 client.close()
 ```
 
-Usage (async)
--------------
+Async example:
 
 ```py
 import asyncio
-from getfreeproxy import AsyncFreeProxyClient
+from freeproxy import AsyncClient
 
 async def main():
-    client = AsyncFreeProxyClient(api_key="YOUR_API_KEY")
+    client = AsyncClient(api_key="YOUR_API_KEY")
     proxies = await client.query(country="US")
     for p in proxies:
-        print(p.proxy_url)
+        print(p.to_url())
     await client.aclose()
 
 asyncio.run(main())
 ```
 
-Tests
------
+Authentication
+--------------
+Provide your API key to the client constructor. The client sends `Authorization: Bearer <API_KEY>` in requests.
 
-Install dev dependencies and run tests:
+Query parameters
+----------------
+- `country`: ISO 3166-1 alpha-2 country code (e.g. `US`).
+- `protocol`: proxy protocol filter like `http`, `https`, `socks5`.
+- `page`: pagination page index (integer).
 
-```bash
-pip install -e .[dev]
-pytest -q
-```
-
-Publishing
-----------
+Errors and exceptions
+---------------------
+- `APIError` is raised for non-2xx HTTP responses. The message attempts to surface the API `error` field when present, otherwise it falls back to the response body.
+- `InvalidAPIKey` is a subclass used when the API returns HTTP 401.
+- `NetworkError` and `TimeoutError` wrap transport-level failures.
 
-This repository uses a GitHub Actions workflow to publish to PyPI when a tag matching `vX.Y.Z` is pushed.
+Notes and limitations
+---------------------
+- This client intentionally keeps runtime dependencies minimal and does not implement automatic retries. It also does not stream responses — responses are small (up to ~10 proxies per request).
 
-Preparation (one-time):
-- Create a PyPI API token at https://pypi.org/ (Account > API tokens).
-- Add the token to GitHub repository secrets as `PYPI_API_TOKEN` (Repository Settings > Secrets).
-
-Release steps (recommended via CI):
-
-1. Bump `version` in `pyproject.toml` to the new release version (for example `0.0.2`).
-2. Create a signed or annotated tag and push it:
+Testing
+-------
+Run the test suite locally with:
 
 ```bash
-git tag -a v0.0.2 -m "Release v0.0.2"
-git push origin v0.0.2
+pip install -e .[dev]
+pytest -q
 ```
 
-When the tag is pushed, GitHub Actions will run `.github/workflows/release.yml` and publish the built distributions to PyPI using the `PYPI_API_TOKEN` secret.
-
-You can also build and upload locally (useful for dry-run checks):
+License
+-------
+MIT
 
-```bash
-python -m pip install --upgrade build twine
-python -m build
-python -m twine check dist/*
-# then upload (will require PyPI credentials or token):
-python -m twine upload dist/*
-```
 

freeproxy/__init__.py

@@ -0,0 +1,6 @@
+from ._version import __version__
+from .models import Proxy
+from .client import Client
+from .async_client import AsyncClient
+
+__all__ = ["__version__", "Proxy", "Client", "AsyncClient"]

getfreeproxy/_utils.py freeproxy/_utils.pygetfreeproxy/_utils.py renamed to freeproxy/_utils.py

@@ -15,7 +15,6 @@ def extract_error_message(body_text: str, json_body: Optional[Dict] = None) -> s
                 return str(json_body.get("error"))
             if "message" in json_body:
                 return str(json_body.get("message"))
-            # fallback to first string-like field
             for k in ("detail", "code"):
                 if k in json_body:
                     return str(json_body.get(k))

freeproxy/_version.py

@@ -0,0 +1,2 @@
+__version__ = "1.0.0"
+

getfreeproxy/async_client.py freeproxy/async_client.pygetfreeproxy/async_client.py renamed to freeproxy/async_client.py

@@ -6,7 +6,7 @@
 from ._utils import build_headers, extract_error_message
 
 
-class AsyncFreeProxyClient:
+class AsyncClient:
     def __init__(self, api_key: str, *, base_url: str = "https://api.getfreeproxy.com", timeout: float = 30.0, user_agent: Optional[str] = None, session: Optional[httpx.AsyncClient] = None):
         self.api_key = api_key
         self.base_url = base_url.rstrip("/")

getfreeproxy/client.py freeproxy/client.pygetfreeproxy/client.py renamed to freeproxy/client.py

@@ -6,7 +6,7 @@
 from ._utils import build_headers, extract_error_message
 
 
-class FreeProxyClient:
+class Client:
     def __init__(self, api_key: str, *, base_url: str = "https://api.getfreeproxy.com", timeout: float = 30.0, user_agent: Optional[str] = None, session: Optional[httpx.Client] = None):
         self.api_key = api_key
         self.base_url = base_url.rstrip("/")