Skip to main content

ADscan launcher (host-side) that orchestrates Docker to run the ADscan runtime.

Project description

ADscan (PyPI Launcher)

This PyPI package provides the adscan command as a lightweight Python launcher.

The launcher is responsible for:

  • pulling the ADscan Docker image (adscan install)
  • running the ADscan CLI inside Docker (adscan start, adscan ci, and passthrough commands)

The full ADscan CLI implementation lives inside the Docker image.

Requirements

  • Linux host (x86_64)
  • Docker Engine + Docker Compose plugin installed
  • Permission to run Docker (root or user in the docker group)

Quick Start

pip install adscan
adscan install
adscan start

Local development with uv

If you cloned this repository and want to run the launcher locally:

uv sync --extra dev
uv run adscan --help
uv run adscan version

Run lint/tests/build with uv:

uv run ruff check adscan_core adscan_launcher adscan_internal
uv run pytest -m unit
uv run python -m build

Install from TestPyPI (Kali)

Use this when validating a TestPyPI release on Kali:

python -m pip install \
  --index-url https://test.pypi.org/simple/ \
  --extra-index-url https://pypi.org/simple \
  adscan --break-system-packages

Install a specific TestPyPI version:

python -m pip install \
  --index-url https://test.pypi.org/simple/ \
  --extra-index-url https://pypi.org/simple \
  adscan==5.0.0.devYYYYMMDDHHMMSS --break-system-packages

Configuration

Override the Docker image used by the launcher:

export ADSCAN_DOCKER_IMAGE="adscan/adscan-lite:latest"

Use the dev channel image:

export ADSCAN_DOCKER_CHANNEL=dev

User Documentation

User-facing installation, troubleshooting, and Docker/BloodHound operational guidance is maintained in the ADscan docs site:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adscan-6.2.0.tar.gz (219.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adscan-6.2.0-py3-none-any.whl (233.6 kB view details)

Uploaded Python 3

File details

Details for the file adscan-6.2.0.tar.gz.

File metadata

  • Download URL: adscan-6.2.0.tar.gz
  • Upload date:
  • Size: 219.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for adscan-6.2.0.tar.gz
Algorithm Hash digest
SHA256 c45d6261a4953cb499a26a2b106ce030f47973e7d2de2f5dba386b5dfba488f8
MD5 f9f3822411a027761f3648fcdcf55897
BLAKE2b-256 0cc0a1e22e659f2339a8e3235e8c3d898d848efb2378b9a22994bb0a9008976c

See more details on using hashes here.

File details

Details for the file adscan-6.2.0-py3-none-any.whl.

File metadata

  • Download URL: adscan-6.2.0-py3-none-any.whl
  • Upload date:
  • Size: 233.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for adscan-6.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3fbf0671417ce80c5bb07614244bb60595630d57947a09909b1e629e951f4c1f
MD5 5111d578d4a97670eb89fe6ae267451d
BLAKE2b-256 0aeac07cca076718e3b0ff61cba932588fe1069de7deb73f96914a68f43031b6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page