Metadata-Version: 2.1
Name: free-proxy
Version: 1.0.1
Summary: Proxy scraper for further use
Home-page: https://github.com/jundymek/free-proxy
Author: jundymek
Author-email: jundymek@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: lxml
Requires-Dist: requests


# Free-proxy  

## Get free working proxy from https://www.sslproxies.org/ and use it in your script  

FreeProxy class scrapes proxies from https://www.sslproxies.org/ and checkes if proxy is working. There is posibility to  
filter proxies by country and acceptable timeout. You can also randomize list of proxies from where script would get   
first working proxy.  

You can use it in sending request through custom proxy, with selenium or wherever you want.  

Returns proxy as string:  
```  
'113.160.218.14:8888'  
```  

### Requirements  

* Python3  

* Request library  

* Lxml library  

### Installation

```
pip install free-proxy
```
[![asciicast](https://asciinema.org/a/Xolpn3eD2tyJl8Y8HE9zolgex.svg)](https://asciinema.org/a/Xolpn3eD2tyJl8Y8HE9zolgex)

### Usage with examples  

First import Free Proxy that way:
```python
from fp.fp import FreeProxy
```

## Options

Parameter | Type| Example | Default value
--- | --- | --- | --- 
country_id | list | ['US', 'BR'] | None
timeout | float > 0 |0.1 | 0.5
rand | bool | True | False


* **No parameters**   
Get first working proxy from 100 proxies from https://www.sslproxies.org/  
```
proxy = FreeProxy().get()  
```  
* **`country_id` parameter**   
Get first working proxy from specified list of countries. If there is no valid proxy from specified list check all countries  
```  
proxy = FreeProxy(country_id=['US', 'BR']).get()  
```  
* **`timeout` parameter**   
Timeout is parameter for checking if proxy is valid. If test site doesn't respond in specified time  
script marks this proxy as invalid. Default ```timeout=0.5```. You can change it by defining  
specified timeout eg. ```timeout=1```.  
```  
proxy = FreeProxt(timeout=1).get()  
```  
* **`rand` parameter** 
```
proxy = FreeProxy(rand=True).get()  
```  

Shuffles proxy list from https://www.sslproxies.org/. Default `rand=False` and searches for working proxy from newest 
to oldest (as they are listed in https://www.sslproxies.org/).

You can combine parameters:  
```  
proxy = FreeProxy(country_id=['US', 'BR'], timeout=0.3, rand=True).get()  
```  

If there is no working proxy script returns `None`  

#Changelog
## [1.0.1] - 2020-03-19
### Changed
- Fix typos in readme
- Fix urrlib3 exception `urllib3.exceptions.ProxySchemeUnknown: Not supported proxy scheme None`,
- Fix imports

License  
----  

MIT  


**Free Software!**

