Metadata-Version: 2.1
Name: hideip
Version: 0.1.0
Summary: Hide your IP from the Internet
Home-page: https://github.com/tquangsdh20/hideip
Author: Joseph Quang
Author-email: tquang.sdh20@hcmut.edu.vn
License: Apache 2.0
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Platform: macOS
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Requires-Dist: requests (>=2.23)
Requires-Dist: PySocks (>=1.7)

<p align="center">
<img src="https://raw.githubusercontent.com/tquangsdh20/hideip/main/.github/logo.svg">
<img src="https://github.com/tquangsdh20/hideip/actions/workflows/github-build.yml/badge.svg?style=plastic"> <a href="https://app.codecov.io/gh/tquangsdh20/hideip/blob/6ad7e9708f36c63f003c5fd6b1d2c763da50703d/hideip/hideip.py"><img src="https://codecov.io/gh/tquangsdh20/hideip/branch/main/graphs/badge.svg?branch=main"></a> <img src="https://img.shields.io/github/license/tquangsdh20/hideip"> <img src = "https://img.shields.io/pypi/pyversions/hideip"> <img src="https://img.shields.io/badge/author-tquangsdh20-orange">
</p>

## Installation

**Windows**
```
python -m pip install hideip
```

**macOS**
```
sudo pip install hideip
```

**Linux**
```
pip install hideip
```

## Major Features

- Open file SOCKS5 proxy
- Get the avaiable proxy in the file
- Torrent the proxy

## How to use?

First of all, we need the file SOCKS5 download it from [HideMe](https://hideip.me/en/proxy/socks5list)

```python
from hideip import HideMe

# The path file socks5.csv
file = 'socks5.csv'
hide = HideMe(file)

# Get the avaiable proxy
proxy = hide.torrent()

# Print 
print(proxy)

```

## Use with requests library

The socks5 maybe not support `verify`, therefore we need to set it `False`. We might want to turn off the InsecureRequest warning. 

```python
import requests
from hideip import HideMe


# Turn off warning, please ignore if you don't want
from urllib3.exceptions import InsecureRequestWarning
requests.packages.urllib3.disable_warnings(category=InsecureRequestWarning)

# Get the proxy
file = 'socks5.csv'
hide = HideMe(file)
hideme = hide.torrent()

# Requests
res = requests.get('https://httpbin.org/ip',proxies = hideme, verify = False, timeout = 2)
print(res.text)

```

