Metadata-Version: 2.1
Name: hiddenbot
Version: 0.0.3
Summary: Dark Web Crawler
Author: hdks
Author-email: hdks.bug@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: beautifulsoup4 (>=4.12.2,<5.0.0)
Requires-Dist: httpx[socks] (>=0.25.0,<0.26.0)
Requires-Dist: stem (>=1.8.2,<2.0.0)
Requires-Dist: tld (>=0.13,<0.14)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Requires-Dist: validators (>=0.22.0,<0.23.0)
Description-Content-Type: text/markdown

# HiddenBot

Dark web crawler.

## Prerequisites

### Tor

Access to onion services, we need to use **Tor** proxy.

```sh
# If tor is not installed...
sudo apt install tor

tor &
```

To check if you're using Tor from command line, run the following command:

```sh
curl -fsSL -x socks5://127.0.0.1:9050 check.torproject.org | grep Congratulations
```

If the content "Congratulations. This browser is configured to use Tor." appeared, your Tor proxy configuration is correct.

### Virual Machine (Optional)

It's recommended to use a virtual machine for more securely connecting to dark web.

<br />

## Usage

```sh
hiddenbot run -u https://xxx...xxx.onion/

# Depth (-d)
hiddenbot run -u https://xxx...xxx.onion/ -d 5

# Output (-o)
hiddenbot run -u https://xxx...xxx.onion/ -o result.json
```

- `hiddenbot` currently extracts **title**, **description** and **URL** only.
- Extracted data is saved to a **JSON** file.

<br />

## Installation

### From Pip

```sh
pip install hiddenbot
```

### From Source

```sh
git clone https://github.com/hideckies/hiddenbot.git
cd hiddenbot
poetry install
poetry shell
hiddenbot --help
```
