Installation

VoidCrawl requires Python 3.10+ and Chrome/Chromium installed on your system.

Install from PyPI

uv add voidcrawl

pip install voidcrawl

poetry add voidcrawl

Verify the install

import voidcrawl
print(dir(voidcrawl))
# ['BrowserConfig', 'BrowserPool', 'BrowserSession', 'Page', 'PoolConfig', 'PooledTab']

Install from Source (Rust dev setup)

Building from source requires a Rust toolchain. This compiles the Rust CDP core and installs the Python extension into your virtualenv.

Prerequisites

Requirement	Minimum Version
Python	3.10+
Rust	1.86+
Chrome / Chromium	Any recent version
maturin	1.7+
uv	latest

Build

Clone the repository

git clone https://github.com/CascadingLabs/VoidCrawl

Navigate into the project directory
```
cd VoidCrawl
```
Build and install the extension
```
./build.sh
```
This runs maturin develop --release which compiles the Rust extension and installs it into the active virtualenv.
Optional: Install all Python dependency groups (dev, tests, etc.)
```
uv sync --all-groups
```

Manual build (without build.sh)

maturin develop --release --manifest-path crates/pyo3_bindings/Cargo.toml

For CI, maturin build --release produces a distributable wheel.

FAQs

Do I need Rust installed to use VoidCrawl?

No. Pre-built wheels are published to PyPI for common platforms. You only need Rust if you want to build from source or contribute to the Rust core.

Which Chrome do I need?

Any recent version of Chrome or Chromium. VoidCrawl connects via CDP, which is stable across Chrome versions. If google-chrome --version or chromium --version runs on your system, you are good.

Can I use a custom Chrome binary?

Yes. Pass chrome_executable="/path/to/chrome" to BrowserConfig, or set the binary path in your environment. See the API Reference for details.

References

△ maturin. PyO3 Contributors. Build and publish Rust crates as Python packages. https://www.maturin.rs/

○ uv. Astral. Python package and project manager. https://docs.astral.sh/uv/