Metadata-Version: 2.4
Name: hww
Version: 1.1
Summary: This package contains the essentials for HouseWideWeb, a decentralized network system. It includes the DNS, a server framework, and a client that you can customize.
Author-email: jhfhngj <ezzeldinahmed1@outlook.com>
Maintainer-email: jhfhngj <ezzeldinahmed1@outlook.com>
License-Expression: CC0-1.0
Project-URL: Homepage, https://github.com/jhfhngj/HouseWideWeb
Keywords: network,decentralized,house,web,housewide,dns
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# 🏠 HouseWideWeb (HWW)
Welcome to HouseWideWeb, a decentralized network system designed to be lightweight, flexible, and fun to use. Whether you're building a local service or a distributed app, HWW gives you the tools to register, resolve, and connect — all without the baggage of traditional DNS.

## 🚀 Getting Started

Here's how you can get started with HouseWideWeb easily!

### 1. Run the DNS Registry Server

This is the backbone of HWW — a simple DNS registry that maps domains to IP addresses and ports.

```
from hww.dns import DNSRegistryServer

server = DNSRegistryServer()
server.start()
```

Run this on any computer or server. It listens for `reg ` and `get` requests to register and resolve HWW domains.

### 2. Build Your HWW Server


Use the HWW server framework to create your own service.
```
from hww import HWWServer

server = HWWServer()
server.start()
```

You can extend `HWWServer` with custom logic to handle incoming connections. It's lightweight, so any computer can be a server.

### 3. Register Your Domain

Before clients can find your server, you need to register it with the DNS registry.

Send a registration request like this using the later shown client base or a custom one:

```
reg ilove.manypieces.ofpie
```

No TLDs required — go wild with names!

### 4. Connect with the HWW Client

Use the client framework to resolve domains and interact with services.

```
from hww import DNSClient, ServiceConnector

dns = DNSClient()
status, ip_port = dns.send_request("get", "hww://example.com")

if "100 OK" in status and ip_port:
    ip, port = ip_port.split(":")
    connector = ServiceConnector(ip, int(port))
    connector.interact()
else:
    print("Failed to resolve domain.")
```

### 🧠 How It Works

- DNSRegistryServer: Accepts reg <domain> to register and get <domain> to resolve.

- HWWServer: Listens for incoming connections and handles service logic.

- DNSClient: Sends requests to the DNS server.

- ServiceConnector: Connects to resolved services and enables interaction.

### 🧪 Example Flow

1. Start your DNS server.

2. Start your HWW service.

3. Register your domain with the DNS server.

4. Use the client to resolve and connect to your service.

Example domain: hww://computerstore.com 
Example registration: reg computerstore.com 
Example resolution: get computerstore.com
