From 0556a448b9bdc037838db8aaa9b3f552bf3fb5c2 Mon Sep 17 00:00:00 2001 From: theworker02 Date: Tue, 22 Sep 2026 11:48:55 -0400 Subject: [PATCH] Make repository acquisition-ready with proprietary sale license. --- README.md | 71 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 39 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 9f570a3..a17a74f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ # BotScope + +--- + +## License & acquisition + +This project is **proprietary**. Production use, redistribution, and commercial deployment require a written commercial license or completed acquisition. See [LICENSE](./LICENSE) and [ACQUISITION.md](./ACQUISITION.md). Contact [@theworker02](https://github.com/theworker02). + + BotScope **Python-first observability for an Internet-wide census of automated traffic.** -BotScope is an **Internet-wide bot traffic census**: the Global Observatory federates public crawler/IP panels, crawl catalogs, and optional CDN estimates into a worldwide automation picture — alongside a local analyzer and native Qt desktop Observatory for authorized logs, sessions, and live capture. +BotScope is an **Internet-wide bot traffic census**: the Global Observatory federates public crawler/IP panels, crawl catalogs, and optional CDN estimates into a worldwide automation picture — alongside a local analyzer and native Qt desktop Observatory for authorized logs, sessions, and live capture. [![CI](https://github.com/theworker02/botscope/actions/workflows/ci.yml/badge.svg)](https://github.com/theworker02/botscope/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/botscope.svg)](https://pypi.org/project/botscope/) @@ -17,7 +25,7 @@ BotScope is an **Internet-wide bot traffic census**: the Global Observatory fede [![Tests](https://img.shields.io/badge/tests-pytest-0A9EDC?logo=pytest&logoColor=white)](https://github.com/theworker02/botscope/actions/workflows/ci.yml) [![Status](https://img.shields.io/badge/status-v2.0.0%20beta-informational)](CHANGELOG.md) -**Install from PyPI:** [`pip install botscope`](https://pypi.org/project/botscope/) · GUI: [`pip install "botscope[gui]"`](https://pypi.org/project/botscope/) +**Install from PyPI:** [`pip install botscope`](https://pypi.org/project/botscope/) · GUI: [`pip install "botscope[gui]"`](https://pypi.org/project/botscope/) > Network contribution is **OFF by default**. BotScope does not perform unauthorized scanning. > Zero-config for your own logs: **no account**, **no cloud profile**, and **no API key** required to classify local traffic. @@ -26,7 +34,7 @@ BotScope is an **Internet-wide bot traffic census**: the Global Observatory fede ## Try in 60 seconds -No GUI, no network, no API keys — just a labeled offline demo: +No GUI, no network, no API keys — just a labeled offline demo: ```bash pip install botscope @@ -58,18 +66,18 @@ First-hour guide: [`docs/guides/EASE_OF_ACCESS.md`](docs/guides/EASE_OF_ACCESS.m Observatory dashboard with DEMO DATA banner, KPIs, composition ring, and Traffic Pulse

-*Observatory — KPI cards, composition ring, Traffic Pulse, and category breakdown on the bundled synthetic demo corpus (DEMO DATA banner visible).* +*Observatory — KPI cards, composition ring, Traffic Pulse, and category breakdown on the bundled synthetic demo corpus (DEMO DATA banner visible).* | | | |:--:|:--:| -| Global Observatory Internet-wide census
*Global — Internet-wide census from zero-auth public sources; Cloudflare Radar optional* | Events table with query filter
*Events — virtualized table, query language, Classification Inspector* | -| Bot Library known vs observed
*Bot Library — known signatures vs observed-in-dataset markers* | Sources registry table
*Sources — registry status for public feeds and optional providers* | +| Global Observatory Internet-wide census
*Global — Internet-wide census from zero-auth public sources; Cloudflare Radar optional* | Events table with query filter
*Events — virtualized table, query language, Classification Inspector* | +| Bot Library known vs observed
*Bot Library — known signatures vs observed-in-dataset markers* | Sources registry table
*Sources — registry status for public feeds and optional providers* |

Settings preferences panel

-*Settings — local theme, privacy, and optional Cloudflare Radar token for CDN estimates (field shown empty; no account required).* +*Settings — local theme, privacy, and optional Cloudflare Radar token for CDN estimates (field shown empty; no account required).* --- @@ -81,9 +89,9 @@ Animated tour of the main Observatory pages (demo data): BotScope GUI tour animated GIF

-[Screenshot strip](docs/assets/demo/botscope-tour-strip.png) · [Recording script / MP4 placeholder](docs/assets/demo/README.md) +[Screenshot strip](docs/assets/demo/botscope-tour-strip.png) · [Recording script / MP4 placeholder](docs/assets/demo/README.md) -To capture a short screen recording yourself (launch → Demo → KPIs → Global → Events), follow the steps in [`docs/assets/demo/README.md`](docs/assets/demo/README.md) and drop `botscope-demo.mp4` (or `.webm`) beside the GIF. +To capture a short screen recording yourself (launch → Demo → KPIs → Global → Events), follow the steps in [`docs/assets/demo/README.md`](docs/assets/demo/README.md) and drop `botscope-demo.mp4` (or `.webm`) beside the GIF. --- @@ -95,16 +103,16 @@ BotScope is an **Internet-wide census of automated traffic**, with a local measu - Classify requests from combined/common access logs (and optional PCAP / live paths) - Separate **OBSERVED** totals from **CLASSIFIED** shares, with provenance badges - Keep an honest **UNKNOWN** outcome instead of forcing certainty -- Explore both **global census views** and local sessions in a **native desktop Observatory** (Qt / PySide6 — not a website) +- Explore both **global census views** and local sessions in a **native desktop Observatory** (Qt / PySide6 — not a website) ## What BotScope is not -- **Not** limited to a single site or sensor — Global Observatory is the Internet-wide census surface +- **Not** limited to a single site or sensor — Global Observatory is the Internet-wide census surface - **Not** a claim that one local log alone equals the whole Internet (local shares stay labeled local; the census comes from federated global sources) -- **Not** a cloud SaaS — analysis and preferences stay on your machine by default +- **Not** a cloud SaaS — analysis and preferences stay on your machine by default - **Not** a substitute for authorization: only analyze systems and traffic you own or have permission to measure -The product’s primary global story is the **Internet-wide census**. Local Observatory KPIs remain dataset-scoped so you can compare your sensors against that census without conflating the two. +The product’s primary global story is the **Internet-wide census**. Local Observatory KPIs remain dataset-scoped so you can compare your sensors against that census without conflating the two. --- @@ -120,7 +128,7 @@ The product’s primary global story is the **Internet-wide census**. Local | **Dataset Health** | Multi-dimension quality scorecard for the loaded session | | **Events** | Virtualized event browser, quick search, shared safe query language | | **Compare** | Session-to-session deltas and classifier-vs-labels panels (no causal claims) | -| **Provenance** | OBSERVED vs CLASSIFIED vs INFERRED — numbers keep their lineage | +| **Provenance** | OBSERVED vs CLASSIFIED vs INFERRED — numbers keep their lineage | | **Exports** | Multi-format reports (Markdown, HTML, JSON, CSV) and research export helpers | | **Live capture** | Authorized log-tail and optional local-interface sniff; measured rates only | | **CLI + Python API** | Headless analyze / query / report / doctor alongside the GUI | @@ -190,7 +198,7 @@ print(result.automation_fraction) print(result.stats.by_category) ``` -More detail: [`docs/guides/EASE_OF_ACCESS.md`](docs/guides/EASE_OF_ACCESS.md) · [`docs/guides/QUICKSTART.md`](docs/guides/QUICKSTART.md) · [`docs/guides/INSTALLATION.md`](docs/guides/INSTALLATION.md) +More detail: [`docs/guides/EASE_OF_ACCESS.md`](docs/guides/EASE_OF_ACCESS.md) · [`docs/guides/QUICKSTART.md`](docs/guides/QUICKSTART.md) · [`docs/guides/INSTALLATION.md`](docs/guides/INSTALLATION.md) --- @@ -225,27 +233,27 @@ Run `botscope --help` or `botscope --help` for options. Tutorials live ``` Access log / PCAP / live sensor - │ - â–¼ + │ + â–¼ Ingest + privacy transforms - │ - â–¼ + │ + â–¼ Classify (rules, identity, optional ML) - │ - ├──► .bscope session store (events, aggregates, workspace) - ├──► CLI reports / export / research packs - └──► Observatory GUI (KPIs, Events, Global census, Live, …) - │ - └──► Global federation → Internet-wide census + │ + ├──► .bscope session store (events, aggregates, workspace) + ├──► CLI reports / export / research packs + └──► Observatory GUI (KPIs, Events, Global census, Live, …) + │ + └──► Global federation → Internet-wide census (zero-auth public sources; Cloudflare Radar if you supply a token) ``` -- **Internet-wide census**: Global Observatory is the census product — federated public panels and optional CDN estimates. +- **Internet-wide census**: Global Observatory is the census product — federated public panels and optional CDN estimates. - **Local-first**: sessions and preferences stay on disk unless you explicitly enable network contribution. - **Provenance-aware**: OBSERVED counts are never relabeled as CLASSIFIED shares; local KPIs stay distinct from the global census. -- Methodology notes: [`docs/research/METHODOLOGY.md`](docs/research/METHODOLOGY.md) · [`docs/research/GLOBAL_ESTIMATION.md`](docs/research/GLOBAL_ESTIMATION.md). +- Methodology notes: [`docs/research/METHODOLOGY.md`](docs/research/METHODOLOGY.md) · [`docs/research/GLOBAL_ESTIMATION.md`](docs/research/GLOBAL_ESTIMATION.md). -Deeper maps: [`docs/architecture/REPOSITORY_MAP.md`](docs/architecture/REPOSITORY_MAP.md) · diagrams in [`docs/architecture/diagrams/`](docs/architecture/diagrams/) · GUI guide [`docs/GUI.md`](docs/GUI.md) +Deeper maps: [`docs/architecture/REPOSITORY_MAP.md`](docs/architecture/REPOSITORY_MAP.md) · diagrams in [`docs/architecture/diagrams/`](docs/architecture/diagrams/) · GUI guide [`docs/GUI.md`](docs/GUI.md) --- @@ -260,7 +268,7 @@ Deeper maps: [`docs/architecture/REPOSITORY_MAP.md`](docs/architecture/REPOSITOR | [`docs/QUERY.md`](docs/QUERY.md) | Safe query language (CLI + GUI + Python) | | [`docs/CAPTURE.md`](docs/CAPTURE.md) | Authorized capture notes | | [`docs/PRIVACY.md`](docs/PRIVACY.md) | Privacy transforms and boundaries | -| [`docs/GLOSSARY.md`](docs/GLOSSARY.md) | Terms (OBSERVED, CLASSIFIED, …) | +| [`docs/GLOSSARY.md`](docs/GLOSSARY.md) | Terms (OBSERVED, CLASSIFIED, …) | | [`docs/research/METHODOLOGY.md`](docs/research/METHODOLOGY.md) | Measurement methodology | | [`docs/research/LIMITATIONS.md`](docs/research/LIMITATIONS.md) | What BotScope will not claim | | [`docs/sources/SOURCE_RESEARCH.md`](docs/sources/SOURCE_RESEARCH.md) | Public source inventory | @@ -296,7 +304,7 @@ Cloudflare Radar is **optional**. Leave Settings blank for normal local-log work 1. Treat **Global Observatory as an Internet-wide census**, built from federated sources with provenance 2. Prefer **UNKNOWN** over forced certainty -3. Separate **OBSERVED** counts from **CLASSIFIED** shares — and local KPIs from the global census +3. Separate **OBSERVED** counts from **CLASSIFIED** shares — and local KPIs from the global census 4. Privacy transforms and local-first storage by default 5. Network contribution remains **OFF** unless explicitly enabled @@ -319,5 +327,4 @@ ruff check src tests scripts ## License -**Source-available proprietary** — evaluation under [LICENSE](./LICENSE); commercial / production use via [COMMERCIAL.md](./COMMERCIAL.md). See [LICENSE_TRANSITION_NOTICE.md](./LICENSE_TRANSITION_NOTICE.md) and [NOTICE](./NOTICE). - +**Source-available proprietary** — evaluation under [LICENSE](./LICENSE); commercial / production use via [COMMERCIAL.md](./COMMERCIAL.md). See [LICENSE_TRANSITION_NOTICE.md](./LICENSE_TRANSITION_NOTICE.md) and [NOTICE](./NOTICE).