Metadata-Version: 2.1
Name: HQApi
Version: 2.4.3
Summary: HQ Trivia & Words API
Home-page: https://github.com/apipy/HQApi
Author: Katant
Author-email: katant.savelev@yandex.ru
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: lomond
Requires-Dist: PyJWT

# HQApi [![Join the chat at https://gitter.im/HQApi/community](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/HQApi/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/apipy/HQApi.svg?branch=master)](https://travis-ci.org/apipy/HQApi) [![Downloads](https://pepy.tech/badge/hqapi)](https://pepy.tech/project/hqapi)
HQ Trivia & Words API, written in Python.

Version 2.4.x may be the latest version of HQApi 2.x. We are already developing 3.x version that will not be compatible with version 1.x and 2.x.

## Installation
1. Install from pip
```bash
pip3 install HQApi
```

2. Install from sources:
```bash
git clone https://github.com/apipy/HQApi.git
cd HQApi
pip install -e .
```

## Usage
Example code to get next show time and info:
```python
from HQApi import HQApi

api = HQApi()

print(api.get_show())
```
Or, you can use CLI to fetch methods
```bash
HQApi -h
```

## Examples
| Example             | Description                                                                                        |
|---------------------|----------------------------------------------------------------------------------------------------|
| `get_show.py`       | [Get next show](https://github.com/apipy/HQApi/blob/master/examples/get_show.py)                   |
| `decode_token.py`   | [Get info from token](https://github.com/apipy/HQApi/blob/master/examples/decode_token.py)         |
| `register_login.py` | [Login or register](https://github.com/apipy/HQApi/blob/master/examples/register_login.py)         |
| `websocket.py`      | [Work with websocket](https://github.com/apipy/HQApi/blob/master/examples/websocket.py)            |
| `websocket_event.py`| [Websocket with events](https://github.com/apipy/HQApi/blob/master/examples/websocket_event.py)    |
| `decode_token.py`   | [Decode JWT token](https://github.com/apipy/HQApi/blob/master/examples/decode_token.py)            |
| `upload_avatar.py`  | [Upload avatar](https://github.com/apipy/HQApi/blob/master/examples/upload_avatar.py)              |
| `offair_trivia.py`  | [Offair trivia](https://github.com/apipy/HQApi/blob/master/examples/offair_trivia.py)              |

## Tor
[How to setup Tor to bypass rate limits](https://github.com/apipy/HQApi/blob/master/tor.md)

## Contact author
* [@lapkioff](https://t.me/lapkioff) - Telegram
* [@katantoff](https://vk.com/katantoff) - VK
* Katant#5251 - Discord
* katant.savelev@yandex.ru - Mail

