Scrapling

(โ˜… 75,655)

๐Ÿ•ท๏ธ An adaptive Web Scraping framework that handles everything from a single request to a full-scale crawl!

  • .bandit.yml
  • .dockerignore
  • .gitignore
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • AI_POLICY.md
  • benchmarks.py
  • cleanup.py
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • Dockerfile
  • LICENSE
  • MANIFEST.in
  • pyproject.toml
  • pytest.ini
  • README.md
  • ROADMAP.md
  • ruff.toml
  • server.json
  • setup.cfg
  • tox.ini
  • zensical.toml

# Installation Guide

1. Get the code
git clone https://github.com/D4Vinci/Scrapling

Downloads the entire project code from GitHub to your computer.

cd Scrapling

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install scrapling

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "scrapling[fetchers]"

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "scrapling[ai]"

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "scrapling[shell]"

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull pyd4vinci/scrapling

Type this command into your terminal and run it.

docker pull ghcr.io/d4vinci/scrapling:latest

Type this command into your terminal and run it.

<a href="https://hub.docker.com/r/pyd4vinci/scrapling" target="_blank">

Type this command into your terminal and run it.

<img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/pyd4vinci/scrapling?labelColor=%20%23FDB062&logo=Docker&labelColor=%20%23528bff"></a>

Type this command into your terminal and run it.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install scrapling

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "scrapling[fetchers]"

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "scrapling[ai]"

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "scrapling[shell]"

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "scrapling[all]"

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation