Skip to content

Lexxythelizard/ConneXx

Repository files navigation

ConneXx – Network Diagnostics & Markdown Logging Tool 📡📝

Modular Network Diagnostic & Logging Tool – built with Python, Markdown, and a sprinkle of nerdy love.


Python Platform License


🚀 What is ConneXx?

ConneXx is a lightweight modular and extensible Python project that helps you:

  • Check internet connectivity
  • Retrieve local and public IP information
  • Analyze HTTP status codes (with fallback retries)
  • Perform ping tests
  • Generate clean, timestamped Markdown log files

It’s perfect for troubleshooting, documentation, teaching, or just satisfying your inner network nerd 😎


✨ Features

  • 🔍 Internet connection check
  • 🌐 Local & public IP info
  • 🛰️ Ping test with encoding fallback
  • 📄 Markdown logger with host + result tracking
  • ✅ Modular architecture with future-proofing

📄 Example Log Output

Status Report from 2025-04-02 10:23

## Device:
- Hostname: DESKTOP-XXXXXX
- Local IP: 19x.xxx.xxx.xx
- External Info:
    - IP: 2.xxx.xxx.xxx
    - City: Bxxxxx
    ...

🧠 Project Structure

ConneXx/
├── main.py                   # Entry point
├── nettools.py               # All network diagnostics
├── markdown_logging.py       # MarkdownLogger class
├── data_and_keys.py          # Shared dictionaries & headers
├── logs/                     # Markdown output directory
├── test/                     # Optional alt output path
├── TECH_SPEC.md              # Technical architecture & future plans
└── README.md

🛠️ Getting Started

Requirements

  • Python 3.10+
  • Works on Windows (tested) & Linux (soon)

Installation

# Clone this repository
$ git clone https://github.com/YourUsername/ConneXx.git
$ cd ConneXx

# (Optional) Create a virtual environment
$ python -m venv .venv
$ source .venv/bin/activate  # or .venv\Scripts\activate on Windows

# Install dependencies (requests)
$ pip install -r requirements.txt

💡 Dependencies are minimal (mostly built-in modules + requests)

Usage

$ python main.py

You’ll get live output, status reports, and a Markdown .md log in the /logs/ folder.


📄 Technical Documentation

For a deeper look into the architecture, modules, and roadmap:
👉 TECH_SPEC.md


📌 Roadmap

See TECH_SPEC.md for detailed plans on:

  • SQLite integration
  • GUI with Tkinter
  • Log statistics
  • Scheduled tests
  • Export to HTML/PDF/JSON

🧑‍💻 Author

Lexxy – aka Lexxythelizard 🦎
Student, coder, creative learner & fan of clarity, structure and sustainable tech.

Built with love, Markdown, and a lot of print() debugging ❤️


🪪 License

This project is licensed under the MIT License – see the LICENSE file.


About

No description, website, or topics provided.

Resources

License

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages