AutoDialer 0.2.3__tar.gz → 0.2.4__tar.gz

{autodialer-0.2.3/src/AutoDialer.egg-info → autodialer-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: AutoDialer
-Version: 0.2.3
+Version: 0.2.4
 Summary: AutoDialer is an automation script designed to interact with routers using APIs.
 Author-email: Byte Flow <fakeshadow1337@gmail.com>
 License-Expression: GPL-3.0-only
@@ -23,52 +23,23 @@ Requires-Dist: requests<3
 Dynamic: license-file
 
 # AutoDialer
-
+![AutoDialer](img/AutoDialer.png)
 AutoDialer is a cross-platform Python CLI package for router APIs, designed to rotate public IP addresses automatically and streamline router interactions.
 
 ## Why AutoDialer?
 - Convenient IP rotation on dynamic lines without manual router reboot.
-- Cross-platform (Windows, Linux, macOS, FreeBSD).
+- Cross-platform (Windows, Linux, macOS, BSD).
 - CLI-first usage for scripts and automation.
 
 ## Installation
 
-### Using pip (recommended)
 ```bash
 pip install autodialer
 ```
 
-### Using uv
-If you prefer `uv` for faster environment and dependency management:
-
-```bash
-# install from PyPI
-uv tool install autodialer
-
-# run directly
-autodialer
-```
-
-For local development:
-
-```bash
-uv sync
-uv pip install -e .
-uv run autodialer --help
-```
-
-### From source (development)
-```bash
-python -m venv .venv
-
-# Windows (PowerShell)
-. .\.venv\Scripts\Activate.ps1
-
-# Linux/macOS
-source .venv/bin/activate
-
-python -m pip install -e .
-```
+## Notes
+- **Only** TP-Link, ZTE and ASUS routers are supported now.
+- Keep `.env` private and never commit credentials.
 
 ## Configuration
 
@@ -78,9 +49,9 @@ Create a `.env` file in your working directory:
 | :--- | :--- |
 | `PANEL_USERNAME` | Router panel username (defaults to `admin`) |
 | `PANEL_PASSWORD` | Router panel password |
-| `PPPOE_USERNAME` | ISP PPPoE username (optional; used when you want to overwrite the router's saved PPPoE config before reconnecting) |
-| `PPPOE_PASSWORD` | ISP PPPoE password (optional; used when you want to overwrite the router's saved PPPoE config before reconnecting) |
-| `ASN` | Target ASN (optional unless not using `--force`) |
+| `PPPOE_USERNAME` | ISP PPPoE username override (optional) |
+| `PPPOE_PASSWORD` | ISP PPPoE password override (optional) |
+| `ASN` | Optional library-level default ASN. The CLI currently expects the ASN to be passed explicitly with `--asn <ASN>`. |
 
 Example:
 ```bash
@@ -96,10 +67,9 @@ ASN='AS9929'
 After installation, use the CLI directly:
 
 ```bash
-autodialer
 autodialer --force
 autodialer --asn AS9929
-autodialer-devices --tplink
+autodialer-devices
 ```
 
 Arguments:
@@ -107,15 +77,17 @@ Arguments:
 - `-a`, `--asn`: target ASN (for example `AS9929` or `9929`).
 
 Behavior:
+- `autodialer` currently requires either `--force` or `--asn <ASN>`.
 - AutoDialer detects current WAN protocol and applies matching reconnection action.
 - PPPoE uses disconnect/connect flow and reuses the router's saved credentials by default.
 - If `PPPOE_USERNAME` and `PPPOE_PASSWORD` are set, AutoDialer updates the router's PPPoE config before reconnecting.
 - DHCP uses DHCP renew flow and shares the same ASN/check/retry control logic.
-- ASUSWRT routers use panel authentication plus WAN restart through the ASUS web API.
 
-## Notes
-- TP-Link and ASUS routers are supported by default.
-- Keep `.env` private and never commit credentials.
+## Documentation
+
+- Setup and CLI details: [`docs/getting-started.md`](docs/en/docs/getting-started.md)
+- Detection and reconnection flow: [`docs/how-it-works.md`](docs/en/docs/how-it-works.md)
+- Contribution guide: [`CONTRIBUTING.md`](CONTRIBUTING.md)
 
 ---
 Thanks for using AutoDialer.

autodialer-0.2.3/README.MD → autodialer-0.2.4/README.md

@@ -1,50 +1,21 @@
 # AutoDialer
-
+![AutoDialer](img/AutoDialer.png)
 AutoDialer is a cross-platform Python CLI package for router APIs, designed to rotate public IP addresses automatically and streamline router interactions.
 
 ## Why AutoDialer?
 - Convenient IP rotation on dynamic lines without manual router reboot.
-- Cross-platform (Windows, Linux, macOS, FreeBSD).
+- Cross-platform (Windows, Linux, macOS, BSD).
 - CLI-first usage for scripts and automation.
 
 ## Installation
 
-### Using pip (recommended)
 ```bash
 pip install autodialer
 ```
 
-### Using uv
-If you prefer `uv` for faster environment and dependency management:
-
-```bash
-# install from PyPI
-uv tool install autodialer
-
-# run directly
-autodialer
-```
-
-For local development:
-
-```bash
-uv sync
-uv pip install -e .
-uv run autodialer --help
-```
-
-### From source (development)
-```bash
-python -m venv .venv
-
-# Windows (PowerShell)
-. .\.venv\Scripts\Activate.ps1
-
-# Linux/macOS
-source .venv/bin/activate
-
-python -m pip install -e .
-```
+## Notes
+- **Only** TP-Link, ZTE and ASUS routers are supported now.
+- Keep `.env` private and never commit credentials.
 
 ## Configuration
 
@@ -54,9 +25,9 @@ Create a `.env` file in your working directory:
 | :--- | :--- |
 | `PANEL_USERNAME` | Router panel username (defaults to `admin`) |
 | `PANEL_PASSWORD` | Router panel password |
-| `PPPOE_USERNAME` | ISP PPPoE username (optional; used when you want to overwrite the router's saved PPPoE config before reconnecting) |
-| `PPPOE_PASSWORD` | ISP PPPoE password (optional; used when you want to overwrite the router's saved PPPoE config before reconnecting) |
-| `ASN` | Target ASN (optional unless not using `--force`) |
+| `PPPOE_USERNAME` | ISP PPPoE username override (optional) |
+| `PPPOE_PASSWORD` | ISP PPPoE password override (optional) |
+| `ASN` | Optional library-level default ASN. The CLI currently expects the ASN to be passed explicitly with `--asn <ASN>`. |
 
 Example:
 ```bash
@@ -72,10 +43,9 @@ ASN='AS9929'
 After installation, use the CLI directly:
 
 ```bash
-autodialer
 autodialer --force
 autodialer --asn AS9929
-autodialer-devices --tplink
+autodialer-devices
 ```
 
 Arguments:
@@ -83,15 +53,17 @@ Arguments:
 - `-a`, `--asn`: target ASN (for example `AS9929` or `9929`).
 
 Behavior:
+- `autodialer` currently requires either `--force` or `--asn <ASN>`.
 - AutoDialer detects current WAN protocol and applies matching reconnection action.
 - PPPoE uses disconnect/connect flow and reuses the router's saved credentials by default.
 - If `PPPOE_USERNAME` and `PPPOE_PASSWORD` are set, AutoDialer updates the router's PPPoE config before reconnecting.
 - DHCP uses DHCP renew flow and shares the same ASN/check/retry control logic.
-- ASUSWRT routers use panel authentication plus WAN restart through the ASUS web API.
 
-## Notes
-- TP-Link and ASUS routers are supported by default.
-- Keep `.env` private and never commit credentials.
+## Documentation
+
+- Setup and CLI details: [`docs/getting-started.md`](docs/en/docs/getting-started.md)
+- Detection and reconnection flow: [`docs/how-it-works.md`](docs/en/docs/how-it-works.md)
+- Contribution guide: [`CONTRIBUTING.md`](CONTRIBUTING.md)
 
 ---
-Thanks for using AutoDialer.
+Thanks for using AutoDialer.

{autodialer-0.2.3 → autodialer-0.2.4}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "AutoDialer"
 authors = [{name = "Byte Flow", email = "fakeshadow1337@gmail.com"}]
 description = "AutoDialer is an automation script designed to interact with routers using APIs."
-readme = "README.MD"
+readme = "README.md"
 requires-python = ">=3.10"
 license = "GPL-3.0-only"
 dynamic = ["version"]

{autodialer-0.2.3 → autodialer-0.2.4/src/AutoDialer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: AutoDialer
-Version: 0.2.3
+Version: 0.2.4
 Summary: AutoDialer is an automation script designed to interact with routers using APIs.
 Author-email: Byte Flow <fakeshadow1337@gmail.com>
 License-Expression: GPL-3.0-only
@@ -23,52 +23,23 @@ Requires-Dist: requests<3
 Dynamic: license-file
 
 # AutoDialer
-
+![AutoDialer](img/AutoDialer.png)
 AutoDialer is a cross-platform Python CLI package for router APIs, designed to rotate public IP addresses automatically and streamline router interactions.
 
 ## Why AutoDialer?
 - Convenient IP rotation on dynamic lines without manual router reboot.
-- Cross-platform (Windows, Linux, macOS, FreeBSD).
+- Cross-platform (Windows, Linux, macOS, BSD).
 - CLI-first usage for scripts and automation.
 
 ## Installation
 
-### Using pip (recommended)
 ```bash
 pip install autodialer
 ```
 
-### Using uv
-If you prefer `uv` for faster environment and dependency management:
-
-```bash
-# install from PyPI
-uv tool install autodialer
-
-# run directly
-autodialer
-```
-
-For local development:
-
-```bash
-uv sync
-uv pip install -e .
-uv run autodialer --help
-```
-
-### From source (development)
-```bash
-python -m venv .venv
-
-# Windows (PowerShell)
-. .\.venv\Scripts\Activate.ps1
-
-# Linux/macOS
-source .venv/bin/activate
-
-python -m pip install -e .
-```
+## Notes
+- **Only** TP-Link, ZTE and ASUS routers are supported now.
+- Keep `.env` private and never commit credentials.
 
 ## Configuration
 
@@ -78,9 +49,9 @@ Create a `.env` file in your working directory:
 | :--- | :--- |
 | `PANEL_USERNAME` | Router panel username (defaults to `admin`) |
 | `PANEL_PASSWORD` | Router panel password |
-| `PPPOE_USERNAME` | ISP PPPoE username (optional; used when you want to overwrite the router's saved PPPoE config before reconnecting) |
-| `PPPOE_PASSWORD` | ISP PPPoE password (optional; used when you want to overwrite the router's saved PPPoE config before reconnecting) |
-| `ASN` | Target ASN (optional unless not using `--force`) |
+| `PPPOE_USERNAME` | ISP PPPoE username override (optional) |
+| `PPPOE_PASSWORD` | ISP PPPoE password override (optional) |
+| `ASN` | Optional library-level default ASN. The CLI currently expects the ASN to be passed explicitly with `--asn <ASN>`. |
 
 Example:
 ```bash
@@ -96,10 +67,9 @@ ASN='AS9929'
 After installation, use the CLI directly:
 
 ```bash
-autodialer
 autodialer --force
 autodialer --asn AS9929
-autodialer-devices --tplink
+autodialer-devices
 ```
 
 Arguments:
@@ -107,15 +77,17 @@ Arguments:
 - `-a`, `--asn`: target ASN (for example `AS9929` or `9929`).
 
 Behavior:
+- `autodialer` currently requires either `--force` or `--asn <ASN>`.
 - AutoDialer detects current WAN protocol and applies matching reconnection action.
 - PPPoE uses disconnect/connect flow and reuses the router's saved credentials by default.
 - If `PPPOE_USERNAME` and `PPPOE_PASSWORD` are set, AutoDialer updates the router's PPPoE config before reconnecting.
 - DHCP uses DHCP renew flow and shares the same ASN/check/retry control logic.
-- ASUSWRT routers use panel authentication plus WAN restart through the ASUS web API.
 
-## Notes
-- TP-Link and ASUS routers are supported by default.
-- Keep `.env` private and never commit credentials.
+## Documentation
+
+- Setup and CLI details: [`docs/getting-started.md`](docs/en/docs/getting-started.md)
+- Detection and reconnection flow: [`docs/how-it-works.md`](docs/en/docs/how-it-works.md)
+- Contribution guide: [`CONTRIBUTING.md`](CONTRIBUTING.md)
 
 ---
 Thanks for using AutoDialer.

{autodialer-0.2.3 → autodialer-0.2.4}/src/AutoDialer.egg-info/SOURCES.txt

@@ -1,5 +1,5 @@
 LICENSE
-README.MD
+README.md
 pyproject.toml
 src/AutoDialer.egg-info/PKG-INFO
 src/AutoDialer.egg-info/SOURCES.txt
@@ -17,6 +17,8 @@ src/autodialer/apis/routers/asus/__init__.py
 src/autodialer/apis/routers/asus/asus_api.py
 src/autodialer/apis/routers/tplink/__init__.py
 src/autodialer/apis/routers/tplink/tplink_api.py
+src/autodialer/apis/routers/zte/__init__.py
+src/autodialer/apis/routers/zte/zte_api.py
 src/autodialer/apis/utils/check_isp.py
 src/autodialer/apis/utils/check_vendor.py
 src/autodialer/apis/utils/get_gateway.py
@@ -27,10 +29,13 @@ src/autodialer/config/__init__.py
 src/autodialer/config/config.py
 src/autodialer/encode/__init__.py
 src/autodialer/encode/tplink_security_encode.py
+src/autodialer/encode/zte_encode.py
 tests/test_asus_api.py
 tests/test_check_isp.py
+tests/test_check_vendor.py
 tests/test_get_gateway.py
 tests/test_get_vendor_api.py
 tests/test_pppoe.py
 tests/test_reconnection.py
-tests/test_tplink_api.py
+tests/test_tplink_api.py
+tests/test_zte_api.py

{autodialer-0.2.3 → autodialer-0.2.4}/src/autodialer/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.3"
+__version__ = "0.2.4"
 
 from .apis.utils.check_isp import check_isp, check_isp_with_retries
 from .apis.utils.get_gateway import (

{autodialer-0.2.3 → autodialer-0.2.4}/src/autodialer/apis/routers/asus/asus_api.py

@@ -7,6 +7,7 @@ from urllib.parse import quote
 
 import requests
 
+from autodialer.apis.routers.base_api import RouterAPI
 from autodialer.apis.utils.get_gateway import format_ip_for_url_host, get_gateway_ip
 from autodialer.config.config import PANEL_PASSWORD, PANEL_USERNAME
 
@@ -23,7 +24,7 @@ MAC_ADDRESS_PATTERN = re.compile(r"^(?:[0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$")
 logger = logging.getLogger(__name__)
 
 
-class AsusAPI:
+class AsusAPI(RouterAPI):
     """Interact with ASUSWRT routers using the web API."""
 
     SUPPORTED_VENDORS = ("ASUS", "ASUS AiMesh")

{autodialer-0.2.3 → autodialer-0.2.4}/src/autodialer/apis/routers/tplink/tplink_api.py

@@ -1,7 +1,7 @@
 import logging
 import requests
 from autodialer import encode
-
+from autodialer.apis.routers.base_api import RouterAPI
 from autodialer.apis.utils.get_gateway import format_ip_for_url_host, get_gateway_ip
 from time import sleep
 from typing import Literal
@@ -16,7 +16,7 @@ logger = logging.getLogger(__name__)
 """
 
 
-class TPLinkAPI:
+class TPLinkAPI(RouterAPI):
     """A class to interact with TP-Link routers using their API.
 
     Attributes: