Metadata-Version: 2.4
Name: awnet
Version: 0.1.0
Summary: A peer registry and reachability layer — which peers exist, and can I reach one? It detects three distinct states: unknown, unreachable, and unable-to-check. It is NOT a VPN implementation.
License: Apache-2.0
Project-URL: Homepage, https://github.com/Aitherium/awnet
Project-URL: Documentation, https://github.com/Aitherium/awnet#readme
Project-URL: Repository, https://github.com/Aitherium/awnet.git
Project-URL: Issues, https://github.com/Aitherium/awnet/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Dynamic: license-file

# awnet

<!-- aither-header:start GENERATED from the ecosystem registry. Edits here are overwritten; change the registry instead. -->

**[Docs](https://aitherium.github.io/awnet/)**  ·  [Source](https://github.com/Aitherium/awnet)  ·  `pip install awnet`  ·  [The Aither World](https://aitherium.github.io/)

> **The Aither World** is an operating system for agents — a Linux you can hand to one, the runtimes it works in, and the tools it works with. [awnix](https://github.com/Aitherium/awnix) is the Linux underneath it; **awnet** is one of its 33 bricks — each installs on its own, runs offline, and needs no account.
>
> **Start here:** Host a mesh on one machine and join it from another.

<!-- aither-header:end -->

The **overlay/fabric layer** — which peers exist, and can I reach one?

```bash
pip install awnet
```

```python
from awnet import Registry, check_peer

reg = Registry("peers.json")
reg.add_peer("node1", ["node1.local:8080"])
reg.save()

result = check_peer("node1.local:8080")
if result.ok is True:
    print("peer is reachable")
elif result.ok is False:
    print("peer is known but unreachable")
else:  # ok is None
    print("could not determine")
```

```bash
awnet add peers.json node1 node1.local:8080
awnet check node1.local:8080        # 0 ok · 1 unreachable · 2 unknown
awnet list peers.json
awnet get peers.json node1
```

## What it actually does

Separates two distinct concerns:

1. **Registry**: which peers EXIST (their names and endpoints).
2. **Reachability**: whether I CAN REACH one right now.

**A peer that resolves is not a peer that is reachable.** DNS working does not
mean the service is listening. A hostname resolve today can be unreachable
tomorrow. A reachability cache is a thing that keeps saying "up" for days after
the peer is gone.

Three distinct states, reported as three different things:

| verdict | ok | meaning |
|---|---|---|
| `ok` | `True` | peer answers on the network |
| `unreachable` | `False` | peer exists (DNS works) but does not answer |
| `unknown` | `None` | we tried to check but could not determine |

Why this matters:

- `Unknown` means try again. The network is the issue, not the peer.
- `Unreachable` means the peer is gone. Update your route or failover.
- `True` means the peer is here. Use it.

Three outcomes that call for three different responses. A test that treats them
the same is a test that would pass whether the distinction is there or not.

## How it checks

1. **DNS resolution** — can I name the peer?
   - If DNS fails → unreachable (ok=False)
   - If DNS times out → unknown (ok=None)

2. **TCP connect** (if DNS succeeds) — is anything listening?
   - If connect succeeds → ok (ok=True)
   - If connect is refused → unreachable (ok=False)
   - If connect times out → unreachable (ok=False)
   - If connect errors → unknown (ok=None)

Socket is closed after each check (no resource leak).

## What it does not do — stated, not papered over

**This is NOT a VPN implementation.** It is the addressing and reachability
layer ABOVE one. You bring your own network; awnet tells you which peers are
there and whether you can reach them.

**A reachability check is a point-in-time snapshot.** A peer that answers at
check-time might be gone by the time you route to it. awnet returns what it
found; it does not promise that it will still be true when you use the result.

Conversely, **a peer marked unreachable five minutes ago might be back.** awnet
does NOT cache results. Every check is fresh. If you want caching, keep it
separate and ALWAYS expire it explicitly — a cache that forgets to expire is
more dangerous than no cache at all.

**TCP port 80 (HTTP) is the only probe.** awnet does not know about HTTPS,
gRPC, custom protocols, or anything else. If your peer listens on a different
port, awnet will reach it. If your peer only answers TLS and you probe plain
HTTP, awnet will report it unreachable (which is correct: plain HTTP is
unreachable on that peer). The separation is intentional — a fabric layer that
understands every protocol is a fabric layer that understands none of them.

## Tests

Every claim has a mutation that breaks it. Happy-path tests would let the
three-state distinction disappear into the code and break silently.

```bash
pip install -e ".[dev]" && pytest
```

A reachability check that doesn't assert the SPECIFIC state is one that would
pass whether the three values (True, False, None) are actually different or not.

## Design notes

- **No dependencies.** A fabric layer that needs an install before it can be
  read is one nobody reads during an incident. Only the stdlib.
- **Registry is separate from checks.** Knowing a peer exists is not the same as
  being able to reach it. Mixing them conflates two distinct questions.
- **Three-valued logic is the whole point.** "Unknown" is not "unreachable".
  The network is not the peer. A test that treats them the same is a test that
  has no teeth.
- **No caching in the library.** If you cache, you own expiry. A library that
  caches and forgets to expire is more dangerous than no library.

## Where it fits

Part of the `aw` family: [awgit](https://github.com/Aitherium/awgit) ·
[awgraph](https://github.com/Aitherium/awgraph) ·
[awseal](https://github.com/Aitherium/awseal) ·
[awdk](https://github.com/Aitherium/awdk) ·
[awdit](https://github.com/Aitherium/awdit) ·
[awnode](https://github.com/Aitherium/awnode)

Apache-2.0.

<!-- aither-ecosystem:start GENERATED from the ecosystem registry. Edits here are overwritten; change the registry instead. -->

## The aw family

Standalone tools that share one idea: **replace something you would otherwise have to _trust_ with something you can _check_.**

Each installs on its own, works offline, and needs no account.

| | instead of trusting | you check |
|---|---|---|
| [awdk](https://github.com/Aitherium/awdk) | a framework's idea of how your agents should run | one loop you can read, pointed at a backend you already pay for |
| [awskills](https://github.com/Aitherium/awskills) | that an agent knows your procedure | the procedure written down, versioned, and loadable by any agent |
| [awm](https://github.com/Aitherium/awm) | that memory stayed in its lane | tenant:user:project scopes, so a write cannot cross a boundary |
| [awnode](https://github.com/Aitherium/awnode) | a vendor's cloud with every prompt | a local gateway routing to backends you chose |
| [awgraph](https://github.com/Aitherium/awgraph) | that grep found everything | an AST + tree-sitter call graph an agent can traverse |
| [awgit](https://github.com/Aitherium/awgit) | that no one else is editing this file | a lease, refused at commit time if you do not hold it |
| [awseal](https://github.com/Aitherium/awseal) | that the artifact came from who you think | an Ed25519 seal — the key that verifies is not the key that forges |
| [awshare](https://github.com/Aitherium/awshare) | that the download is intact | content-addressed bundles, verified on fetch |
| [awnest](https://github.com/Aitherium/awnest) | that there is a person on the other end | a verdict with evidence, where "we could not tell" is not "yes" |
| [awnboard](https://github.com/Aitherium/awnboard) | a share link anyone who sees it can use | an invitation addressed to one person, for one gate, revocable |
| [awnix](https://github.com/Aitherium/awnix) | that the box is what you left it as | an immutable image you built, with atomic rollback |
| [awrecover](https://github.com/Aitherium/awrecover) | that the restore worked | a restore that fully lands or does not land at all |
| [awrelay](https://github.com/Aitherium/awrelay) | a SaaS in the middle of your agents | findings, alerts and coordination over your own transport |
| [awmail](https://github.com/Aitherium/awmail) | a mailbox somebody else can read | mail your agents send and receive over your own server |
| [awfind](https://github.com/Aitherium/awfind) | one vendor's idea of the web | results from whichever providers you configured |
| [awbrowse](https://github.com/Aitherium/awbrowse) | that the page said what you were told | the render, the DOM and the requests it made |
| [aitherkvcache](https://github.com/Aitherium/aitherkvcache) | a vendor's quantisation defaults | sub-byte KV cache kernels you can benchmark yourself |
| [AitherZero](https://github.com/Aitherium/AitherZero) | a pile of scripts nobody has numbered | numbered, discoverable automation with declarative playbooks |
| [AitherConnect](https://github.com/Aitherium/AitherConnect) | what a page tells your browser to do | a federated search and desktop bridge you host |
| [awreason](https://github.com/Aitherium/awreason) | a confident paragraph | the phases it went through, and every tool call it made to get there |
| [awrecurse](https://github.com/Aitherium/awrecurse) | that everything you pasted in was actually read | which slices it opened, and what it concluded from each |
| [awprism](https://github.com/Aitherium/awprism) | the first explanation that fits | the ranked alternatives, and the observation that separates them |
| [awrepl](https://github.com/Aitherium/awrepl) | what the agent believes the value is | the value, printed from the live session |
| [awresearch](https://github.com/Aitherium/awresearch) | a summary of pages nobody opened | every claim against the source it came from |
| [awpredict](https://github.com/Aitherium/awpredict) | a model because it trained without erroring | its prediction against a self-updating lookup, on the rows that are actually novel |
| [awkno](https://github.com/Aitherium/awkno) | that the docs site is up, or that you remember the family | the whole ecosystem in your terminal, with no network at all |

[**awnix**](https://github.com/Aitherium/awnix) is the ground floor — A Linux you can hand to an agent — immutable base, capabilities included.

## The Aitherium ecosystem

Every repository here is public. Each publishes an `aither-manifest.json` beside its page, so any surface can read every sibling's — the network is browsable from any node in it.

| repo | what it is | pages |
|---|---|---|
| [awdk](https://github.com/Aitherium/awdk) | Build AI agent fleets — 3 lines, any backend, local or cloud | [docs](https://aitherium.github.io/awdk/) |
| [awskills](https://github.com/Aitherium/awskills) | Portable agent skills — self-contained procedures an agent loads on demand | [docs](https://aitherium.github.io/awskills/) |
| [awm](https://github.com/Aitherium/awm) | A portable, scoped agent memory | [docs](https://aitherium.github.io/awm/) |
| [awnode](https://github.com/Aitherium/awnode) | A lightweight local gateway — bridges your apps to the AI backends you chose | [docs](https://aitherium.github.io/awnode/) |
| [awrun](https://github.com/Aitherium/awrun) | A priority-aware queue and dispatcher for agentic runs and ad-hoc CI builds | [docs](https://aitherium.github.io/awrun/) |
| [awgraph](https://github.com/Aitherium/awgraph) | A semantic code graph for agents — AST + tree-sitter, call graphs | [docs](https://aitherium.github.io/awgraph/) |
| [awgit](https://github.com/Aitherium/awgit) | Semantic version control on top of git — edit-ops and leases | [docs](https://aitherium.github.io/awgit/) |
| [awseal](https://github.com/Aitherium/awseal) | Sign an artifact so a stranger can verify it | [docs](https://aitherium.github.io/awseal/) |
| [awshare](https://github.com/Aitherium/awshare) | Publish an artifact and fetch it back verified | [docs](https://aitherium.github.io/awshare/) |
| [awdit](https://github.com/Aitherium/awdit) | An append-only audit trail whose gaps are DETECTABLE | [docs](https://aitherium.github.io/awdit/) |
| [awbac](https://github.com/Aitherium/awbac) | Role-based access control that fails closed and explains itself | [docs](https://aitherium.github.io/awbac/) |
| [awiam](https://github.com/Aitherium/awiam) | Who is this caller? A directory and session store that fails honestly | [docs](https://aitherium.github.io/awiam/) |
| [awtunnel](https://github.com/Aitherium/awtunnel) | Reach a service that has no public address | [docs](https://aitherium.github.io/awtunnel/) |
| [awnest](https://github.com/Aitherium/awnest) | Prove there is a human before you let them into the nest | [docs](https://aitherium.github.io/awnest/) |
| [awnboard](https://github.com/Aitherium/awnboard) | A front gate you can put in front of anything, and hand someone the key to | [docs](https://aitherium.github.io/awnboard/) |
| [awnix](https://github.com/Aitherium/awnix) | A Linux you can hand to an agent — immutable base, capabilities included | [docs](https://aitherium.github.io/awnix/) |
| [awrecover](https://github.com/Aitherium/awrecover) | Labelled snapshots with an all-or-nothing restore | [docs](https://aitherium.github.io/awrecover/) |
| [awrelay](https://github.com/Aitherium/awrelay) | Portable agent messaging — findings, alerts, coordination | [docs](https://aitherium.github.io/awrelay/) |
| [awmail](https://github.com/Aitherium/awmail) | Give an agent an email address — send, and actually receive | [docs](https://aitherium.github.io/awmail/) |
| **awnet** _(you are here)_ | The agentic web — agents host a mesh, and agents join one | [docs](https://aitherium.github.io/awnet/) |
| [awfind](https://github.com/Aitherium/awfind) | A portable search client — query, results, ranking | [docs](https://aitherium.github.io/awfind/) |
| [awbrowse](https://github.com/Aitherium/awbrowse) | A portable browser client — navigate, console, network, DOM, screenshot | [docs](https://aitherium.github.io/awbrowse/) |
| [awknowledge](https://github.com/Aitherium/awknowledge) | How to run a coding agent so the result survives — the laws, with evidence | [docs](https://aitherium.github.io/awknowledge/) |
| [aitherkvcache](https://github.com/Aitherium/aitherkvcache) | Near-optimal KV cache quantization for LLM inference — sub-byte compression | [docs](https://aitherium.github.io/aitherkvcache/) |
| [AitherZero](https://github.com/Aitherium/AitherZero) | PowerShell 7+ automation framework — numbered, self-describing scripts | [docs](https://aitherium.github.io/AitherZero/) |
| [AitherConnect](https://github.com/Aitherium/AitherConnect) | Browser extension — federated AI search, page context, and the Living OS overlay | [docs](https://aitherium.github.io/AitherConnect/) |
| [awreason](https://github.com/Aitherium/awreason) | A portable reasoning client — sessions, phases, thoughts, and the chain that produced the answer | [docs](https://aitherium.github.io/awreason/) |
| [awrecurse](https://github.com/Aitherium/awrecurse) | Answer a question over a context far larger than the window — recursively, with the trace kept | [docs](https://aitherium.github.io/awrecurse/) |
| [awprism](https://github.com/Aitherium/awprism) | Turn a failure into ranked hypotheses — and say what would confirm each one | [docs](https://aitherium.github.io/awprism/) |
| [awrepl](https://github.com/Aitherium/awrepl) | A REPL an agent can actually use — state that survives between turns | [docs](https://aitherium.github.io/awrepl/) |
| [awresearch](https://github.com/Aitherium/awresearch) | Ask a research question, get a cited report you can check | [docs](https://aitherium.github.io/awresearch/) |
| [awpredict](https://github.com/Aitherium/awpredict) | Predict what your environment does next, and how surprised you were | [docs](https://aitherium.github.io/awpredict/) |
| [awkno](https://github.com/Aitherium/awkno) | The man page for the Aither World — every brick, stack and law, offline | [docs](https://aitherium.github.io/awkno/) |

<div id="aither-constellation" data-self="awnet"></div>
<script src="aither-constellation.js"></script>

<!-- aither-ecosystem:end -->
