Skip to content

Commit 53f8845

Browse files
committed
Rename to Wayback-Diff, publish as wayback-diff on PyPI
1 parent ced7aba commit 53f8845

File tree

2 files changed

+36
-35
lines changed

2 files changed

+36
-35
lines changed

README.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img src="docs/images/banner.svg" alt="Website-Diff Banner" width="900"/>
2+
<img src="https://raw.githubusercontent.com/GeiserX/Wayback-Diff/main/docs/images/banner.svg" alt="Wayback-Diff Banner" width="900"/>
33
</p>
44

55
<p align="center">
@@ -8,16 +8,17 @@
88

99
<p align="center">
1010
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue?logo=python&logoColor=white" alt="Python Versions"/></a>
11-
<a href="https://github.com/GeiserX/Website-Diff/releases/tag/v1.0.0"><img src="https://img.shields.io/badge/version-1.0.0-orange" alt="Version"/></a>
12-
<a href="https://github.com/GeiserX/Website-Diff/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-GPL--3.0-green" alt="License: GPL-3.0"/></a>
11+
<a href="https://pypi.org/project/wayback-diff/"><img src="https://img.shields.io/pypi/v/wayback-diff?style=flat-square" alt="PyPI"></a>
12+
<a href="https://github.com/GeiserX/Wayback-Diff/releases/tag/v1.0.0"><img src="https://img.shields.io/badge/version-1.0.0-orange" alt="Version"/></a>
13+
<a href="https://github.com/GeiserX/Wayback-Diff/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-GPL--3.0-green" alt="License: GPL-3.0"/></a>
1314
<a href="https://hub.docker.com/"><img src="https://img.shields.io/badge/docker-ready-blue?logo=docker&logoColor=white" alt="Docker"/></a>
1415
</p>
1516

1617
---
1718

18-
## Why Website-Diff?
19+
## Why Wayback-Diff?
1920

20-
Comparing web pages sounds simple until you deal with Wayback Machine injection artifacts, insignificant whitespace noise, and visual regressions invisible to the DOM. **Website-Diff** is a purpose-built CLI that solves all three:
21+
Comparing web pages sounds simple until you deal with Wayback Machine injection artifacts, insignificant whitespace noise, and visual regressions invisible to the DOM. **Wayback-Diff** is a purpose-built CLI that solves all three:
2122

2223
- **Wayback Machine cleaning** -- automatically strips banners, analytics scripts, playback code, and URL rewrites so you compare *actual* content.
2324
- **Significance scoring** -- every change is tagged High, Medium, or Low so you focus on what matters.
@@ -45,16 +46,16 @@ Comparing web pages sounds simple until you deal with Wayback Machine injection
4546
## Quick Start
4647

4748
```bash
48-
pip install -e .
49+
pip install wayback-diff
4950

5051
# Compare two pages
51-
website-diff https://example.com/old https://example.com/new
52+
wayback-diff https://example.com/old https://example.com/new
5253

5354
# Compare a Wayback snapshot with the live site
54-
website-diff https://web.archive.org/web/20230101/https://example.com/ https://example.com/
55+
wayback-diff https://web.archive.org/web/20230101/https://example.com/ https://example.com/
5556

5657
# Full report: visual diff + markdown
57-
website-diff https://old.example.com https://new.example.com --visual --markdown
58+
wayback-diff https://old.example.com https://new.example.com --visual --markdown
5859
```
5960

6061
---
@@ -64,8 +65,8 @@ website-diff https://old.example.com https://new.example.com --visual --markdown
6465
### From source
6566

6667
```bash
67-
git clone https://github.com/GeiserX/Website-Diff.git
68-
cd Website-Diff
68+
git clone https://github.com/GeiserX/Wayback-Diff.git
69+
cd Wayback-Diff
6970
python3 -m venv venv
7071
source venv/bin/activate # Windows: venv\Scripts\activate
7172
pip install -r requirements.txt
@@ -81,8 +82,8 @@ pip install -e ".[visual]"
8182
### Docker
8283

8384
```bash
84-
docker build -t website-diff .
85-
docker run --rm website-diff https://example.com/a https://example.com/b
85+
docker build -t wayback-diff .
86+
docker run --rm wayback-diff https://example.com/a https://example.com/b
8687
```
8788

8889
---
@@ -92,7 +93,7 @@ docker run --rm website-diff https://example.com/a https://example.com/b
9293
### Basic comparison
9394

9495
```bash
95-
website-diff https://example.com/page1 https://example.com/page2
96+
wayback-diff https://example.com/page1 https://example.com/page2
9697
```
9798

9899
### Wayback Machine support
@@ -101,10 +102,10 @@ The tool automatically detects Wayback Machine URLs and cleans injection artifac
101102

102103
```bash
103104
# Archive vs. live site
104-
website-diff https://web.archive.org/web/20230101/https://example.com/ https://example.com/
105+
wayback-diff https://web.archive.org/web/20230101/https://example.com/ https://example.com/
105106

106107
# Two archive snapshots
107-
website-diff \
108+
wayback-diff \
108109
https://web.archive.org/web/20230101/https://example.com/ \
109110
https://web.archive.org/web/20230601/https://example.com/
110111
```
@@ -113,20 +114,20 @@ website-diff \
113114

114115
```bash
115116
# Save to file
116-
website-diff url1 url2 -o diff.txt
117+
wayback-diff url1 url2 -o diff.txt
117118

118119
# JSON (for programmatic consumption)
119-
website-diff url1 url2 --format json
120+
wayback-diff url1 url2 --format json
120121

121122
# Unified diff
122-
website-diff url1 url2 --format unified
123+
wayback-diff url1 url2 --format unified
123124
```
124125

125126
### Site-wide traversal
126127

127128
```bash
128129
# Crawl and compare across linked pages (depth-limited)
129-
website-diff url1 url2 --traverse --depth 2
130+
wayback-diff url1 url2 --traverse --depth 2
130131
```
131132

132133
### Advanced options
@@ -146,19 +147,19 @@ Take screenshots in one or more browsers and generate side-by-side difference im
146147

147148
```bash
148149
# Auto-detect all installed browsers
149-
website-diff url1 url2 --visual
150+
wayback-diff url1 url2 --visual
150151

151152
# Specific browsers
152-
website-diff url1 url2 --visual --browsers chrome firefox edge opera
153+
wayback-diff url1 url2 --visual --browsers chrome firefox edge opera
153154

154155
# Custom viewport
155-
website-diff url1 url2 --visual --viewport-width 1280 --viewport-height 720
156+
wayback-diff url1 url2 --visual --viewport-width 1280 --viewport-height 720
156157

157158
# Non-headless mode (for debugging)
158-
website-diff url1 url2 --visual --no-headless
159+
wayback-diff url1 url2 --visual --no-headless
159160

160161
# Custom screenshot output
161-
website-diff url1 url2 --visual --screenshot-dir ./my-screenshots
162+
wayback-diff url1 url2 --visual --screenshot-dir ./my-screenshots
162163
```
163164

164165
Visual comparison generates:
@@ -173,7 +174,7 @@ Visual comparison generates:
173174
Generate comprehensive Markdown reports that include everything in a single reviewable document:
174175

175176
```bash
176-
website-diff url1 url2 --visual --markdown --report-dir ./reports
177+
wayback-diff url1 url2 --visual --markdown --report-dir ./reports
177178
```
178179

179180
Each report contains:
@@ -187,7 +188,7 @@ Each report contains:
187188

188189
## CI/CD Integration
189190

190-
Website-Diff returns meaningful exit codes designed for pipeline gates:
191+
Wayback-Diff returns meaningful exit codes designed for pipeline gates:
191192

192193
| Exit Code | Meaning |
193194
|-----------|---------|
@@ -213,14 +214,14 @@ jobs:
213214
with:
214215
python-version: "3.11"
215216

216-
- name: Install Website-Diff
217+
- name: Install Wayback-Diff
217218
run: |
218219
pip install -r requirements.txt
219220
pip install -e ".[visual]"
220221
221222
- name: Compare staging vs production
222223
run: |
223-
website-diff \
224+
wayback-diff \
224225
https://staging.example.com \
225226
https://production.example.com \
226227
--visual --markdown --format json -o diff.json
@@ -236,7 +237,7 @@ jobs:
236237
### Shell script gate
237238
238239
```bash
239-
website-diff "$OLD_URL" "$NEW_URL" --format json -o result.json
240+
wayback-diff "$OLD_URL" "$NEW_URL" --format json -o result.json
240241
EXIT_CODE=$?
241242

242243
if [ $EXIT_CODE -eq 2 ]; then
@@ -320,7 +321,7 @@ Standard unified diff format, compatible with `patch` and code review tools.
320321

321322
## Comparison with Similar Tools
322323

323-
| Feature | **Website-Diff** | [htmldiff](https://github.com/ian-ross/htmldiff) | [diff2html](https://github.com/rtfpessoa/diff2html) | [BackstopJS](https://github.com/garris/BackstopJS) | [Percy](https://percy.io) |
324+
| Feature | **Wayback-Diff** | [htmldiff](https://github.com/ian-ross/htmldiff) | [diff2html](https://github.com/rtfpessoa/diff2html) | [BackstopJS](https://github.com/garris/BackstopJS) | [Percy](https://percy.io) |
324325
|---------|:-:|:-:|:-:|:-:|:-:|
325326
| HTML-aware semantic diff | Yes | Yes | No | No | No |
326327
| Wayback Machine artifact cleaning | **Yes** | No | No | No | No |

setup.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
"""Setup configuration for Website-Diff."""
1+
"""Setup configuration for Wayback-Diff."""
22

33
from setuptools import setup, find_packages
44

55
with open("README.md", "r", encoding="utf-8") as fh:
66
long_description = fh.read()
77

88
setup(
9-
name="website-diff",
9+
name="wayback-diff",
1010
version="1.0.0",
1111
author="geiserx",
1212
author_email="sergio@geiser.cloud",
1313
description="A comprehensive tool for comparing web pages with Wayback Machine support",
1414
long_description=long_description,
1515
long_description_content_type="text/markdown",
16-
url="https://github.com/geiserx/Website-Diff",
16+
url="https://github.com/GeiserX/Wayback-Diff",
1717
packages=find_packages(),
1818
classifiers=[
1919
"Development Status :: 3 - Alpha",
@@ -43,7 +43,7 @@
4343
},
4444
entry_points={
4545
"console_scripts": [
46-
"website-diff=website_diff.cli:main",
46+
"wayback-diff=website_diff.cli:main",
4747
],
4848
},
4949
)

0 commit comments

Comments
 (0)