site-scout


Namesite-scout JSON
Version 4.0.1 PyPI version JSON
download
home_pagehttps://github.com/MozillaSecurity/site-scout
SummaryA tool to identify and report browser issues triggered by visiting a list of URLs.
upload_time2025-08-21 17:31:38
maintainerMozilla Fuzzing Team
docs_urlNone
authorTyson Smith
requires_python>=3.9
licenseMPL 2.0
keywords automation testing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Site Scout

[![CI](https://github.com/MozillaSecurity/site-scout/actions/workflows/ci.yml/badge.svg)](https://github.com/MozillaSecurity/site-scout/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/MozillaSecurity/site-scout/branch/main/graph/badge.svg)](https://codecov.io/gh/MozillaSecurity/site-scout)
[![Matrix](https://img.shields.io/badge/chat-%23fuzzing-green?logo=matrix)](https://matrix.to/#/#fuzzing:mozilla.org)
[![PyPI](https://img.shields.io/pypi/v/site-scout)](https://pypi.org/project/site-scout)

Site Scout is a tool that can identify issues that are triggered by visiting live
content. The primary goal is to create a tool that can be used in automation to collect
debugging data for issues such as crashes and assertion failures. A collection of URLs
to visit must be provided.

## Installation

Install the latest version from PyPI:

```bash
pip install site-scout --upgrade
```

## Usage

Visit one or more URLs (typically used to reproduce an issue):
```bash
site-scout <firefox-bin> -u <url> [<url> ...]
```

Visit a collection of URLs from a file:
```bash
site-scout <firefox-bin> -i <urls>.yml [<urls>.yml ...]
```

## Input Formats

**YML** - URLs to visit are stored in the following format:
```yml
# subdomain.domain.tld/path
domain.tld:
  subdomain:
  - /path
# '' is used to omit the subdomain
github.com:
  '':
  - /MozillaSecurity/site-scout
mozilla.org:
  www:
  - /
  - /firefox/browsers/mobile/
  - /firefox/new/
```

**JSONL** - URLs to visits with optional alias:
```jsonl
{"url1.tld": "alias-string-1"}
{"url2.tld/path": "alias-string-2"}
{"sub.url3.tld": null}
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/MozillaSecurity/site-scout",
    "name": "site-scout",
    "maintainer": "Mozilla Fuzzing Team",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "fuzzing@mozilla.com",
    "keywords": "automation testing",
    "author": "Tyson Smith",
    "author_email": "twsmith@mozilla.com",
    "download_url": "https://files.pythonhosted.org/packages/f9/1a/8b6c3fc4e79a8c2a412fbca2377e8d04a131edb433edcfc97a7045abcde9/site_scout-4.0.1.tar.gz",
    "platform": null,
    "description": "# Site Scout\n\n[![CI](https://github.com/MozillaSecurity/site-scout/actions/workflows/ci.yml/badge.svg)](https://github.com/MozillaSecurity/site-scout/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/MozillaSecurity/site-scout/branch/main/graph/badge.svg)](https://codecov.io/gh/MozillaSecurity/site-scout)\n[![Matrix](https://img.shields.io/badge/chat-%23fuzzing-green?logo=matrix)](https://matrix.to/#/#fuzzing:mozilla.org)\n[![PyPI](https://img.shields.io/pypi/v/site-scout)](https://pypi.org/project/site-scout)\n\nSite Scout is a tool that can identify issues that are triggered by visiting live\ncontent. The primary goal is to create a tool that can be used in automation to collect\ndebugging data for issues such as crashes and assertion failures. A collection of URLs\nto visit must be provided.\n\n## Installation\n\nInstall the latest version from PyPI:\n\n```bash\npip install site-scout --upgrade\n```\n\n## Usage\n\nVisit one or more URLs (typically used to reproduce an issue):\n```bash\nsite-scout <firefox-bin> -u <url> [<url> ...]\n```\n\nVisit a collection of URLs from a file:\n```bash\nsite-scout <firefox-bin> -i <urls>.yml [<urls>.yml ...]\n```\n\n## Input Formats\n\n**YML** - URLs to visit are stored in the following format:\n```yml\n# subdomain.domain.tld/path\ndomain.tld:\n  subdomain:\n  - /path\n# '' is used to omit the subdomain\ngithub.com:\n  '':\n  - /MozillaSecurity/site-scout\nmozilla.org:\n  www:\n  - /\n  - /firefox/browsers/mobile/\n  - /firefox/new/\n```\n\n**JSONL** - URLs to visits with optional alias:\n```jsonl\n{\"url1.tld\": \"alias-string-1\"}\n{\"url2.tld/path\": \"alias-string-2\"}\n{\"sub.url3.tld\": null}\n```\n",
    "bugtrack_url": null,
    "license": "MPL 2.0",
    "summary": "A tool to identify and report browser issues triggered by visiting a list of URLs.",
    "version": "4.0.1",
    "project_urls": {
        "Homepage": "https://github.com/MozillaSecurity/site-scout"
    },
    "split_keywords": [
        "automation",
        "testing"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bfe12e6ac4878986e015c05cff1851aa396061c1ac90757783089c84738c5176",
                "md5": "c7cd248da0bc610ce1fe7a55c3f78790",
                "sha256": "0c65556ba59d6121d43c7e2d731977717ecfea11183a027afc529309d0862fc2"
            },
            "downloads": -1,
            "filename": "site_scout-4.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c7cd248da0bc610ce1fe7a55c3f78790",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 49468,
            "upload_time": "2025-08-21T17:31:37",
            "upload_time_iso_8601": "2025-08-21T17:31:37.522656Z",
            "url": "https://files.pythonhosted.org/packages/bf/e1/2e6ac4878986e015c05cff1851aa396061c1ac90757783089c84738c5176/site_scout-4.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f91a8b6c3fc4e79a8c2a412fbca2377e8d04a131edb433edcfc97a7045abcde9",
                "md5": "9439299fe52748ba58a405594a4237dd",
                "sha256": "52e444f5a0674abde9ee798e86210f267530b512d26d248ddca1505d444010f9"
            },
            "downloads": -1,
            "filename": "site_scout-4.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "9439299fe52748ba58a405594a4237dd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 43599,
            "upload_time": "2025-08-21T17:31:38",
            "upload_time_iso_8601": "2025-08-21T17:31:38.835234Z",
            "url": "https://files.pythonhosted.org/packages/f9/1a/8b6c3fc4e79a8c2a412fbca2377e8d04a131edb433edcfc97a7045abcde9/site_scout-4.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-21 17:31:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MozillaSecurity",
    "github_project": "site-scout",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "site-scout"
}
Tyson Smith
Elapsed time: 0.44192s