Metadata-Version: 2.4
Name: hack4her-review-data
Version: 0.1.2
Summary: Synthetic multilingual accommodation review data generator for Hack4Her travel-safety prototypes.
Author: Hack4Her Data Team
Project-URL: Homepage, https://hack4her.github.io/
Project-URL: Repository, https://github.com/iflashlord/hack4her-review-data
Keywords: hack4her,synthetic-data,reviews,travel-safety,booking,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: rich>=13.7.0
Requires-Dist: typer>=0.12.0
Provides-Extra: dev
Requires-Dist: build>=1.2.0; extra == "dev"
Requires-Dist: twine>=5.0.0; extra == "dev"

# Hack4Her Review Data Terminal

Run the Hack4Her synthetic review-data generator from the terminal with:

```bash
uvx hack4her-review-data
```

This opens the Booking.com Hack4Her terminal UI. From there you can generate participant-ready mock accommodation reviews, choose record counts from 1k to 10k, select scenarios, and create public datasets with a 10% labeled golden sample.

All generated reviews are synthetic mock data. They are not real Booking.com reviews and must not be treated as real safety ratings for any property or location.

## Install What You Need

You only need `uv`. It can run the package in an isolated environment and manage Python for you.

### macOS

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

Close and reopen your terminal, then check:

```bash
uv --version
```

### Linux

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

Close and reopen your terminal, then check:

```bash
uv --version
```

### Windows PowerShell

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

Close and reopen PowerShell, then check:

```powershell
uv --version
```

Windows users can also install with WinGet:

```powershell
winget install --id=astral-sh.uv -e
```

## Run

Open the visual terminal:

```bash
uvx hack4her-review-data
```

Generate the default starter pack directly:

```bash
uvx hack4her-review-data starter --records 1000
```

Show available scenarios:

```bash
uvx hack4her-review-data scenarios
```

Check your setup:

```bash
uvx hack4her-review-data doctor
```

## Output

Generated files are written to:

```text
data_output_generated/
```

For public participant datasets, the main file hides organizer/evaluation labels and a separate `_golden_10pct` file includes labels for 10% of rows.

## Credits

Engineers who worked on the development of this tool:

- Behrouz Pooladrak
- Lalith Sai Swaroop
