Metadata-Version: 2.4
Name: pychecknet
Version: 0.1.1
Summary: A sleek, custom terminal speedtest runner using Rich and Typer
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: speedtest-cli
Requires-Dist: typer
Requires-Dist: rich
Dynamic: license-file

# ⚡ pychecknet

[![PyPI version](https://img.shields.io/pypi/v/pychecknet.svg?color=blue)](https://pypi.org/project/pychecknet/)
[![Python Version](https://img.shields.io/pypi/pyversions/pychecknet.svg?color=cyan)](https://pypi.org/project/pychecknet/)
[![License: MIT](https://img.shields.io/badge/License-MIT-magenta.svg)](https://opensource.org/licenses/MIT)

A sleek, ultra-clean, and modern Command Line Interface (CLI) network speed test runner. Built dynamically using **Typer** for processing arguments and **Rich** for beautiful rendering layout panels and status spinners directly within your shell.

---

## ✨ Features

* **Sleek UX/UI:** Renders beautiful, clean, modern dashboard tables inside colored boxes.
* **Live Status Tracking:** Displays contextual, animated dots spinners while servers are queried and tested.
* **Auto-Scaling Bitrate:** Intelligently parses raw bitstream outputs up to the highest human-readable metrics (`Mbps`, `Gbps`, etc.).
* **Global Binary Binding:** Installs natively into your operating system shell paths to execute from anywhere.

---

## 🚀 Installation

Install the package globally or within your isolated runtime environment directly using `pip`:

```bash
pip install pychecknet
```

---

## ⚡ Usage

Once installed, you don't even need to type the package namespace. Simply call the globally linked binary shortcut in your terminal emulator:

```bash
speedtest
```

### 🛠️ Interactive Output Interface

```bash
Initializing Speed Test...
⠋ Finding the best server...
⠙ Testing your download and upload speeds...

┌─────────── ⚡ NETWORK SPEED RESULTS ⚡ ───────────┐
│ Ping            17.76 ms                         │
│ Download Speed  160.46 Mbps                      │
│ Upload Speed    85.04 Mbps                       │
└──────────────────────────────────────────────────┘
```

---

## 🛠️ Architecture Overview

The system architecture decouples configuration declarations from execution logic using standard modern Python build conventions:

```text
PySpeed/
├── pyproject.toml        # Modern PEP 621 packaging metadata & dependencies
└── pyspeed/
    ├── __init__.py       # Namespace initialization flag
    └── cli.py            # Core application entrypoint and UI render pipeline
```

* **`pyproject.toml`:** Declares build-system parameters (`setuptools`), package dependencies (`speedtest-cli`, `typer`, `rich`), and exposes the entrypoint binding `speedtest = "pyspeed.cli:main"`.
* **`cli.py`:** Handles network execution threads and updates the real-time standard output console buffer with styled text components.

---

## 📜 License

Distributed under the **MIT License**. See `LICENSE` for more information.
