semvec/pypi-packages huggingface dataset:
vripper-python 0.1.2
A Python implementation of VRipper
Requires Python: >=3.6

# vripper-python

A Python implementation of VRipper

## Installation

```bash
# Python 3.6+
pip install vripper-python
```

## Usage

```python
from vripper import download_thread

if should_disable_logging:
    logging.getLogger("vripper").setLevel(logging.CRITICAL)

thread_url = "https://..."
dest = "./vripper"

download_thread(thread_url, dest, **options)
```

### Options

|Name|Type|Default Value|Description|
|---|---|---|---|
|`mode`|vripper.enum<br>.downloadmode<br>.DownloadMode|`FIRST_POST_ONLY`|Determines which post(s) within the thread to download.|
|`download_pool_size`|`int`|5|The number of concurrent processes for the download.|
|`output_format`|vripper.enum<br>.outputformat<br>.OutputFormat|None|The desired output format.|
|`constraints`|`dict`|None|A collection of constraints for the pre- and post-processing. See below for more info.|
|`constraints.max_filecount`|`int`|None|The max number of files (images) in a post. If the number of files exceeds the given value, the module will only download a subset of the all images. Ex. Download every 3rd image.|
|`constraints.max_dimension`|`int`|None|The max dimension for an image. If the downlaoded image exceeds the given value, the image will be resized.|
|`constraints.constraint_priority`|vripper.enum<br>.constraintpriority<br>.ConstraintPriority|None|TBD|