Development

Clone the repository:

git clone https://github.com/kacigaya/webskrap.git
cd webskrap

Install development dependencies:

pip install -e ".[dev]"
webskrap install

Run tests and lint:

pytest -q
ruff check .

Build the web docs:

cd web
bun install
bun run build

Use the opt-in live tests only when you need to verify third-party bot-detection behavior:

WEBSKRAP_LIVE=1 pytest -q -m live

They require network access, Patchright, an installed browser, and public demo sites that can change independently from WebSkrap.

With uv

The repository includes uv.lock, so you can run the same commands through uv without activating a shell environment:

uv run pytest -q
uv run ruff check .

Publishing docs

Docs are deployed by GitHub Actions from main.

Repository settings must use:

  • Settings
  • Pages
  • Source: GitHub Actions