sitemap-tracker 2.13.1__tar.gz

sitemap_tracker-2.13.1/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Michael Blaess
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sitemap_tracker-2.13.1/PKG-INFO

@@ -0,0 +1,328 @@
+Metadata-Version: 2.4
+Name: sitemap-tracker
+Version: 2.13.1
+Summary: Sitemap Tracker - crawls websites, generates sitemap.xml, tracks dead links and SEO issues in a TUI
+Author: Michael Blaess
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/michaelblaess/sitemap-tracker
+Project-URL: Repository, https://github.com/michaelblaess/sitemap-tracker
+Project-URL: Issues, https://github.com/michaelblaess/sitemap-tracker/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: textual>=0.85.0
+Requires-Dist: playwright>=1.40.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: lxml>=5.0.0
+Requires-Dist: textual-image[textual]>=0.12.0
+Requires-Dist: textual-fspicker>=0.4.0
+Requires-Dist: Pillow>=10.0
+Requires-Dist: textual-themes[textual]>=0.15.1
+Requires-Dist: textual-widgets>=0.32.1
+Requires-Dist: textual-slider>=0.2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.5; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: poethepoet>=0.29; extra == "dev"
+Requires-Dist: ruff>=0.3; extra == "dev"
+Dynamic: license-file
+
+# Sitemap Tracker
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/michaelblaess/sitemap-tracker/64b53c6892d70fe877c894961ef815f55d0858ad/docs/flags/gb.svg" height="13" alt=""> <b>English</b> ·
+  <img src="https://raw.githubusercontent.com/michaelblaess/sitemap-tracker/64b53c6892d70fe877c894961ef815f55d0858ad/docs/flags/de.svg" height="13" alt=""> <a href="https://github.com/michaelblaess/sitemap-tracker/blob/64b53c6892d70fe877c894961ef815f55d0858ad/README.de.md">Deutsch</a>
+</p>
+
+---
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/michaelblaess/sitemap-tracker/64b53c6892d70fe877c894961ef815f55d0858ad/docs/banner.jpg" alt="sitemap-tracker - a website as a node graph beside an XML sitemap with change badges" width="100%">
+</p>
+
+[![Stars](https://img.shields.io/github/stars/michaelblaess/sitemap-tracker?logo=github&logoColor=white&color=fbbf24)](https://github.com/michaelblaess/sitemap-tracker/stargazers)
+[![Forks](https://img.shields.io/github/forks/michaelblaess/sitemap-tracker?logo=github&logoColor=white&color=34d399)](https://github.com/michaelblaess/sitemap-tracker/network/members)
+[![Issues](https://img.shields.io/github/issues/michaelblaess/sitemap-tracker?logo=github&logoColor=white&color=f87171)](https://github.com/michaelblaess/sitemap-tracker/issues)
+[![Pull Requests](https://img.shields.io/github/issues-pr/michaelblaess/sitemap-tracker?logo=github&logoColor=white&color=a78bfa)](https://github.com/michaelblaess/sitemap-tracker/pulls)
+
+[![Last Commit](https://img.shields.io/github/last-commit/michaelblaess/sitemap-tracker?logo=git&logoColor=white&color=3b82f6)](https://github.com/michaelblaess/sitemap-tracker/commits/main)
+[![License](https://img.shields.io/badge/license-Apache_2.0-3b82f6)](https://github.com/michaelblaess/sitemap-tracker/blob/64b53c6892d70fe877c894961ef815f55d0858ad/LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10+-3b82f6?logo=python&logoColor=white)](https://www.python.org/)
+
+Crawls websites and generates standard-compliant `sitemap.xml` files. Uses [Playwright](https://playwright.dev/) for JavaScript rendering or [httpx](https://www.python-httpx.org/) for fast HTTP crawling.
+
+## Screenshots
+
+### Main View
+![Main View](https://raw.githubusercontent.com/michaelblaess/sitemap-tracker/64b53c6892d70fe877c894961ef815f55d0858ad/docs/screenshots/01-main.png)
+
+### Sitemap Tree
+![Sitemap Tree](https://raw.githubusercontent.com/michaelblaess/sitemap-tracker/64b53c6892d70fe877c894961ef815f55d0858ad/docs/screenshots/02-sitemap.png)
+
+### Crawl History
+![Crawl History](https://raw.githubusercontent.com/michaelblaess/sitemap-tracker/64b53c6892d70fe877c894961ef815f55d0858ad/docs/screenshots/03-history.png)
+
+## Installation
+
+### One-Liner (Standalone, no Python required)
+
+**Linux / macOS:**
+```bash
+curl -fsSL https://raw.githubusercontent.com/michaelblaess/sitemap-tracker/main/install.sh | bash
+```
+
+**Windows (PowerShell):**
+```powershell
+irm https://raw.githubusercontent.com/michaelblaess/sitemap-tracker/main/install.ps1 | iex
+```
+
+> **Intel Macs:** the installer finds no package there. Release binaries are
+> built for Apple Silicon (arm64) only, and Rosetta cannot help - it translates
+> x86 to arm, not the other way round. Run from source instead: clone the
+> repository, then `./bootstrap.sh` once and `./run.sh` to start. That route
+> needs [uv](https://docs.astral.sh/uv/), which fetches the Python matching
+> your processor.
+
+## Usage
+
+```bash
+# Simple crawl (httpx mode, fast)
+sitemap-tracker https://example.com
+
+# With JavaScript rendering (Playwright)
+sitemap-tracker https://example.com --render
+
+# Save sitemap directly
+sitemap-tracker https://example.com --output sitemap.xml
+
+# Limit crawl depth
+sitemap-tracker https://example.com --max-depth 5
+
+# More concurrency
+sitemap-tracker https://example.com --concurrency 16
+
+# Ignore robots.txt
+sitemap-tracker https://example.com --ignore-robots
+
+# With cookies (e.g. for login)
+sitemap-tracker https://example.com --cookie session=abc123
+```
+
+## CLI Parameters
+
+| Parameter | Description | Default |
+|---|---|---|
+| `URL` | Start URL of the website | - |
+| `--output`, `-o` | Output path for sitemap.xml | `sitemap_<host>_<timestamp>.xml` |
+| `--max-depth`, `-d` | Maximum crawl depth | 10 |
+| `--concurrency`, `-c` | Parallel requests | 8 |
+| `--rate-limit` | Max requests per minute (0 = no limit) | 60 |
+| `--timeout`, `-t` | Timeout per page (seconds) | 30 |
+| `--render` | Render JavaScript with Playwright | off |
+| `--no-headless` | Browser visible (debugging) | off |
+| `--ignore-robots` | Ignore robots.txt | off |
+| `--user-agent` | Custom User-Agent | Chrome 131 |
+| `--cookie` | Set cookie (NAME=VALUE, multiple) | - |
+
+## Keyboard Shortcuts (TUI)
+
+| Key | Function |
+|---|---|
+| `c` | Start crawl (URL dialog) |
+| `x` | Cancel crawl / JSON error report |
+| `m` | Save sitemap (save-as dialog) |
+| `s` | Settings |
+| `g` | Export form report (JSON) |
+| `j` | JIRA table to clipboard |
+| `e` | Show errors only |
+| `f` | Sitemap diff |
+| `d` | Copy URL details |
+| `l` | Toggle log |
+| `h` | History |
+| `z` | Crawl summary (score, findings) |
+| `v` | Show the broken link in the referring page source (4xx/5xx rows) |
+| `?` | HTTP status code reference |
+| `i` | Info dialog |
+| `q` | Quit |
+
+Copying / exporting the log runs via right-click on the log panel.
+Hovering a shortcut in the footer reveals a full tooltip explaining what it does.
+URLs in the log, header and detail panel are clickable without holding Ctrl.
+
+## Features
+
+- **Dual mode**: httpx (fast, HTML only) or Playwright (JavaScript rendering)
+- **robots.txt**: Respected by default, `--ignore-robots` to disable
+- **Auto-split**: With >50,000 URLs, an automatic sitemap index with partial sitemaps
+- **Priority**: Automatically based on crawl depth (home page = 1.0)
+- **lastmod**: From HTTP Last-Modified header
+- **URL normalization**: Duplicates avoided through normalization
+- **Redirect-target resolution (same-host aliases)**: A sitemap normally lists only crawled HTTP-200 HTML pages — pure redirects (301/302) are left out, because they have no content of their own. But there is one special case: when a redirect points to a page **on the same host that is not otherwise listed** (an internal *alias*, e.g. `/old-path` → `/new-path` where `/new-path` is only reachable via the redirect), that resolved target would fall through the cracks and never end up in the sitemap. The writer therefore writes the **resolved target** into the sitemap instead of silently dropping the redirect. Three rules keep this safe and standard-compliant:
+  1. **Already covered → skipped.** If the redirect resolves to a page that is already listed as a 200 page, it is dropped — scanning it again would just duplicate the existing page.
+  2. **Same target → one entry.** Several redirects pointing at the same target collapse into a single sitemap entry.
+  3. **Same host only.** Only targets on the **exact same host** are added. A `sitemap.xml` may, per the [sitemaps.org standard](https://www.sitemaps.org/protocol.html#location), only contain URLs from the host it lives on — so redirects to **sibling subdomains** (e.g. `www.waerme.enviam.de` redirecting to `www.enviam.de` or `www.solar.enviam.de`) or to foreign domains are **excluded**. They belong in the sitemap of *their own* site, not this one. If you want those pages scanned, crawl that host directly.
+
+  Note: the resolved target's *final* HTTP status is not re-fetched (the crawler only stored the original 301), so a broken same-host alias target shows up as an error in the downstream scan — which is exactly what you want to see.
+- **Form detection**: `<form>` tags are detected, marked in the table and exportable as JSON
+- **Dead-link source viewer**: For every 4xx/5xx page, jump to the referring page's HTML and see the exact line that contains the broken link — Pygments-highlighted, the match line painted in a warm gold band. From there: open the source in your browser, copy a paste-ready snippet (broken URL + ±3 lines of context + line number) to the clipboard, or save the full HTML as evidence
+- **Results context menu**: Right-click on any results row for the five bulk actions (toggle errors-only filter, save sitemap as XML, save error report as JSON, copy JIRA table, generate forms report). 4xx/5xx rows additionally get a one-click jump into the broken-link source viewer
+- **JIRA table in two formats** (Settings -> Export): **Markdown** for Jira Cloud (converts to a real table when pasted into a comment) and **Wiki markup** for older Jira Server/Data Center instances
+- **Live TUI**: Progress, statistics and URL details in real time — results table and page tree split across two tabs
+- **Sortable results**: Click any column header (Status, HTTP, Depth, Links, Form, Time, Size, Date, URL) to sort — second click reverses. Active column gets a ▲/▼ marker. Hovering the "Links" header shows a tooltip clarifying it counts the internal links found on the page
+- **Crawl summary**: When a crawl finishes, a modal shows a site score (0-100 %, share of error-free pages, with an A-F grade) and a findings table (pages crawled / error-free / with errors, HTTP status breakdown, internal links found, **URLs in the sitemap and how many of those are resolved redirect targets** — see "Redirect-target resolution" above). A "Save sitemap" button sits right next to "Close". Re-open it any time with `z`
+- **HTTP status code reference**: Press `?` for a quick lookup table of all common HTTP status codes, grouped by class (2xx/3xx/4xx/5xx) with meaning and explanation - handy to tell a 301 from a 307
+- **Proxy/SSO detection**: Before crawling, the start URL is probed once. If it is redirected to a foreign domain (typical of a proxy, an auth gateway such as Zscaler, or an SSO login like E.ON/Microsoft), a warning modal explains the situation and the crawl is aborted - instead of silently returning just the seed URLs. Redirects within the same registrable domain (e.g. alias 301s to a sibling subdomain) do not trigger it
+- **Date & size columns**: Last-Modified date and page size are shown directly in the results table, side by side with the URL. **Note on size:** the "Size" value is the HTML document size (the delivered source). While crawling, resources such as images, CSS, JS and fonts are **not** loaded, so they do not count towards it - the real total page weight (as a browser reports it) is higher. Hovering the "Size" header explains this
+- **Clickable links**: URLs in the log, crawl header and detail panel open in your default browser on a single click (no Ctrl required); local result files (sitemap.xml, JSON reports) open in the OS default app
+- **Page tree**: Hierarchical view of all crawled URLs with HTTP status, dead-link and not-in-sitemap markers — embedded as a tab, siblings sorted alphabetically; the table's filter applies to the tree as well (matching nodes plus their ancestors stay visible)
+- **URL dialog**: `c` opens a dialog (pre-filled with the last URL) to enter or change the target URL — no restart needed
+- **Crawl header**: All crawl statistics — mode, robots.txt, concurrency, status codes, progress — grouped in one collapsible header
+- **Page details**: Selecting a URL shows grouped panels — page info, issues, tech stack, SEO/meta data and HTTP headers
+- **Footer tooltips**: Every shortcut shows a hover-tooltip explaining what it does — even the cryptic ones like JIRA table, sitemap diff or form report
+- **Issue detection**: Flags common problems per page — HTTP errors, missing/overlong title & description, missing H1/viewport/canonical, `noindex`, slow load, large page
+- **Tech-stack detection**: Detects the CMS, JS/CSS frameworks and server software of each page
+- **Page preview**: Optional in-terminal screenshot of the selected page (TGP/Sixel with half-block fallback) — toggle in settings. Before the shot it accepts the cookie consent, waits for the network to settle and triggers lazy-loaded images, so hero images render instead of being cut off. A live phase indicator (loading page, accepting consent, loading images, capturing) explains why it can take 2-3 seconds
+- **Save-as dialog**: `m` opens a file dialog to choose where to write the `sitemap.xml`, pre-filled with a suggested name and remembering the last folder used
+- **Resizable panels**: Splitters to freely resize the URL table, log and stats panels
+- **Log panel**: Right-click context menu — copy, export to file, or hide
+- **Settings dialog**: Language, robots.txt, Playwright, page preview, concurrency, timeout and crawl depth — persisted across runs
+- **Filter with history**: Filter the URL table by URL/status; recent filter terms in a dropdown
+- **Crawl history**: Past crawls with date, URL, parameters and final stats (crawled / 2xx / errors); date in the UI's locale (DE: `dd.MM.yyyy`, EN: ISO). After picking a URL from the history, the footer `c` (crawl) key blinks to signal you are ready to start
+
+## Browser Strategy
+
+1. **System Chrome** preferred (faster startup, less memory)
+2. **Bundled Chromium** as fallback (included in standalone installation)
+
+## Privacy
+
+**Important**: Crawling a website may be perceived as unusual traffic by the operator. Please note:
+
+- Inform the website operator **before** crawling, especially for large websites
+- Respect `robots.txt` (enabled by default)
+- Keep the rate limit on (see below)
+- This tool is intended for **your own websites** and **authorized analyses**
+
+### Load on the target system
+
+A crawl follows links down to the configured depth, so the number of pages is **not known
+upfront** - unlike a scan of a fixed sitemap. With `--render` every page additionally goes
+through a real Chromium, which bypasses the server's caches and creates several times the load
+of an ordinary visitor. On a large site this quickly adds up to hundreds of requests per minute
+and can noticeably degrade a production system.
+
+The crawler is therefore **rate-limited out of the box**: 60 requests per minute. Change it
+under *Settings -> Crawl* or on the command line:
+
+```bash
+sitemap-tracker https://www.example.com --rate-limit 20   # gentler
+sitemap-tracker https://www.example.com --rate-limit 0    # no limit - be careful
+```
+
+Note that `--concurrency` is **not** a rate limit: it caps how many requests run at the same
+time, not how many go out per minute. And with `--render`, only the page requests are throttled
+- whatever the browser pulls in afterwards (scripts, fonts, images) is not counted, so the real
+load is higher than the configured number.
+
+## Use at your own risk
+
+This program retrieves web pages automatically and thereby places load on the target systems.
+Depending on its settings, that load can exceed the load of an ordinary visitor many times over
+and can impair the availability of the target system.
+
+By using it, you declare that:
+
+1. You will use this program only against systems for which you hold explicit authorisation from
+   their operator.
+2. You bear sole responsibility for its use, for the settings you choose and for all
+   consequences arising from them.
+3. Before running it against a production system, you will verify that the configured limits are
+   appropriate for that system.
+
+The software is provided free of charge and without warranty of any kind ("as is"), as set out in
+section 7 of the Apache License 2.0. The liability of the author (Michael Blaess) for damages
+arising from its use is excluded to the extent permitted by applicable law. Liability for intent
+and gross negligence, for injury to life, body or health, and under mandatory product liability
+law remains unaffected.
+
+On first start the program asks you to confirm this notice.
+
+## When something goes wrong
+
+If the program crashes, the report is written to disk instead of only to the
+terminal - two files next to the settings, both linked from the storage tab in
+the settings once they exist:
+
+| File | What for |
+| --- | --- |
+| `last-crash.txt` | Python errors including the traceback. Written **before** the error dialog runs - if that dialog dies during its own re-layout, the report would otherwise be lost. |
+| `fault.log` | Everything below that: native access violations, stack overflow, fatal interpreter errors. Such crashes bypass Python's error handling entirely. |
+
+Both files are **appended to**, not replaced - a second crash does not hide the
+first one.
+
+`fault.log` also gets a start and an end line per run, which makes the file
+readable at a glance:
+
+| What the file contains | What it means |
+| --- | --- |
+| start, traceback, end | Python error, the program saw it |
+| start, end | exited cleanly |
+| start, then nothing | process was killed - **not** a Python error |
+
+A killed process and a crash look identical in the terminal. Only the missing
+end line tells them apart.
+
+On Windows, prefer starting the program via `run.ps1`: the script restores the
+terminal even when the program crashes hard and can no longer do so itself.
+Otherwise mouse tracking stays on and every mouse move spills control
+characters into your prompt.
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/michaelblaess/sitemap-tracker.git
+cd sitemap-tracker
+
+# Windows
+.\bootstrap.ps1
+
+# Linux/macOS
+./bootstrap.sh
+```
+
+### Local Start
+
+```bash
+# Windows
+.\run.ps1 https://example.com
+
+# Linux/macOS
+./run.sh https://example.com
+```
+
+### Creating a Release
+
+```bash
+git tag vX.Y.Z
+git push origin vX.Y.Z
+```
+
+GitHub Actions automatically builds executables for Windows, Linux and macOS.
+
+## License
+
+Apache License 2.0 - see [LICENSE](https://github.com/michaelblaess/sitemap-tracker/blob/64b53c6892d70fe877c894961ef815f55d0858ad/LICENSE)