crawly-zarcuel 1.0.0
A privacy-focused web scanner that detects cookies and trackers.
License: MIT
Requires Python: >=3.7

# Crawly

**Crawly** is a fast, parallelized web scanner that crawls websites to detect privacy-impacting elements like tracking cookies, social media embeds, and analytics scripts using Playwright and BeautifulSoup.

---

## Features

* 🔍 Detects tracking cookies, social media plugins, analytics tools, and suspicious domains
* ⚡ Fast, multithreaded scanning with ThreadPoolExecutor
* 🎭 Uses Playwright to simulate real browser visits and collect JavaScript-set cookies
* 🧠 Smart filtering of URLs and crawl depth
* 📄 Outputs results to a CSV for easy review

---

## Installation

### Requirements

* Python 3.7 or later

### Install Crawly (for development)

```bash
pip install beautifulsoup4 playwright
playwright install
```

---

## Usage

```bash
python crawly.py -u <start_url> [options]
```

### Options

| Option               | Description                                                             |
| -------------------- | ----------------------------------------------------------------------- |
| `-u`, `--url`        | **Required.** Starting URL to scan                                      |
| `-d`                 | Crawl depth (default: `2`)                                              |
| `-e`, `--exclude`    | List of substrings to exclude from crawling (e.g., `logout`, `contact`) |
| `-w`, `--workers`    | Number of parallel workers/threads (default: `4`)                       |
| `-o`, `--output`     | Output CSV filename (default: `scan_results.csv`)                       |
| `-s`, `--scan-limit` | Max number of pages to scan (optional)                                  |

### Example

```bash
python crawly.py -u https://example.com -d 2 -w 5 -e logout contact -o report.csv
```

---

## Output

The output is a CSV file with columns:

* `URL` – the scanned page
* `Detected` – `Yes` or `No` depending on if trackers were found
* `Source` – all tracking/script sources detected
* `Cookies` – matched cookie names and headers

---



## Author

Zarcuel — Privacy-focused pentester and creator of Crawly 🕷️

MIT License

Copyright (c) 2025 Zarcuel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.