Metadata-Version: 2.1
Name: phub
Version: 2.1
Summary: An API for PornHub
Home-page: https://github.com/Egsagon/PHUB/
Author: Egsagon
Author-email: egsagon12@gmail.com
License: GPLv3
Platform: unix
Platform: linux
Platform: win32
Platform: cygwin
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.11
Classifier: Intended Audience :: Education
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE

![PHUB](https://github.com/Egsagon/PHUB/blob/master/assets/banner.png)

# PHUB - An API for `pornhub.com`.
PHUB is an API wrapper for PornHub. It is able to fetch, search and download videos and supports account connections, achieved with efficient web scrapping using requests and regexes.

## Installation
- Install using pip:
```sh
pip install --upgrade phub
```

- Or using this repository to get latest features:
```sh
pip install --upgrade git+https://github.com/Egsagon/PHUB.git
```

## Usage
Example video download usage:
```python
import phub

client = phub.Client()
video = client.get('enter video URL here')

# Download on working dir with maximum quality
video.download('.', quality = phub.Quality.BEST)
```

Example searching for videos:
```python
record = client.search('enter query here')

# Display all videos (careful if there is a lot of results)
for video in record:
  print(video.title)
```

## Documentation
TODO

## Why?
This project was made as an enhancement for [pfetch](https://github.com/Egsagon/pornhub-fetch), which aimed at downloading videos from PornHub.

I do not plan to maintain this much, so if there are any errors clone the repository and update the regexes in `src/phub/consts` in the `regexes` class.
