-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #42 from lukeprofits/master
Fixed the English in the README.md
- Loading branch information
Showing
1 changed file
with
185 additions
and
186 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,186 +1,185 @@ | ||
| # Free-proxy | ||
|
|
||
| ## Get free working proxy from <https://www.sslproxies.org/>, <https://www.us-proxy.org/>, <https://free-proxy-list.net/uk-proxy.html> and <https://free-proxy-list.net> and use it in your script | ||
|
|
||
| FreeProxy class scrapes proxies from <https://www.sslproxies.org/>, <https://www.us-proxy.org/>, <https://free-proxy-list.net/uk-proxy.html> and <https://free-proxy-list.net> and checks if proxy is working. There is possibility 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: | ||
|
|
||
| ```python | ||
| 'http://113.160.218.14:8888' | ||
| ``` | ||
|
|
||
| ### Requirements | ||
|
|
||
| - Python3 | ||
| - Request library | ||
| - Lxml library | ||
|
|
||
| ### Installation | ||
|
|
||
| ```python | ||
| pip install free-proxy | ||
| ``` | ||
|
|
||
| [](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 | | ||
| | anonym | bool | True | False | | ||
| | elite | bool | True | False | | ||
| | google | bool,None | False | None | | ||
| | https | bool | True | False | | ||
|
|
||
| - **No parameters** | ||
| Get first working proxy from <https://www.sslproxies.org/>. When no proxy is working, repeat once again from <https://free-proxy-list.net> | ||
|
|
||
| ```python | ||
| proxy = FreeProxy().get() | ||
| ``` | ||
|
|
||
| - **`country_id` parameter** | ||
| Get first working proxy from specified list of countries (from <https://www.sslproxies.org/>). If there is no valid proxy from specified list **check all countries** from <https://free-proxy-list.net>. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(country_id=['US', 'BR']).get() | ||
| ``` | ||
|
|
||
| - **`country_id` for US and GB** | ||
| You can set country_id to US and GB to get proxy from United States or United Kingdom. In that case proxies will be scrapped from <https://www.us-proxy.org/> (`US`) or <https://free-proxy-list.net/uk-proxy.html> (`GB`) page. If there is no valid proxy from specified list **check all countries** | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(country_id=['US']).get() | ||
| proxy = FreeProxy(country_id=['GB']).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`. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(timeout=1).get() | ||
| ``` | ||
|
|
||
| - **`rand` parameter** | ||
| 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/>). | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(rand=True).get() | ||
| ``` | ||
|
|
||
| - **`anonym` parameter** | ||
| Return only those proxies that are marked as anonymous. Defaults to `anonym=False` | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(anonym=True).get() | ||
| ``` | ||
|
|
||
| - **`elite` parameter** | ||
| Return only those proxies that are marked as 'elite proxy'. Defaults to `elite=False`. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(elite=True).get() | ||
| ``` | ||
|
|
||
| Note that elite proxies are anonymous at the same time, thus `anonym=True` automatically when `elite=True`. | ||
|
|
||
| - **`google` parameter** | ||
| If `True` it returns only those proxies that are marked as google, if `False` - as no google. Defaults to `google=None` that returns all proxies. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(google=True).get() | ||
| ``` | ||
|
|
||
| - **`https` parameter** | ||
| If true it returns only those proxies that are marked as HTTPS. Defaults to `https=False` - i.e. HTTP proxy (for HTTP websites). | ||
|
|
||
| Note that HTTPS proxy is for both HTTP and HTTPS websites. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(https=True).get() | ||
| ``` | ||
|
|
||
| You can combine parameters: | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(country_id=['US', 'BR'], timeout=0.3, rand=True).get() | ||
| ``` | ||
|
|
||
| If there are no working proxies with provided parameters script raises `FreeProxyException` with `There are no working proxies at this time.` message. | ||
|
|
||
| ## CHANGELOG | ||
|
|
||
| --- | ||
|
|
||
| ## [1.1.1] - 2023-02-18 | ||
|
|
||
| - Fixed https parameter error | ||
| - Fixed additional loop issue when no proxy was found | ||
|
|
||
| ## [1.1.0] - 2022-11-12 | ||
|
|
||
| - Added new website to get proxies from <https://free-proxy-list.net> | ||
| - Added new website to get proxies from <https://free-proxy-list.net/uk-proxy.html> | ||
| - Added new website to get proxies from <https://www.us-proxy.org/> | ||
| - Change lxml version to 4.9.1 | ||
|
|
||
| ## [1.0.6] - 2022-01-23 | ||
|
|
||
| - Added `google` parameter | ||
| - Added `https` parameter | ||
|
|
||
| ## [1.0.5] - 2022-01-07 | ||
|
|
||
| - Added `elite` parameter | ||
| - Add exception class and raise exception instead of system exit | ||
| - Change lxml version to 4.6.5 | ||
|
|
||
| ## [1.0.4] - 2021-11-13 | ||
|
|
||
| - Fix proxy list default length | ||
|
|
||
| ## [1.0.3] - 2021-08-18 | ||
|
|
||
| - Change XPatch due to SSL proxies page update | ||
| - Change lxml version | ||
|
|
||
| ## [1.0.2] - 2020-09-03 | ||
|
|
||
| - Added `anonym` parameter | ||
|
|
||
| ## [1.0.1] - 2020-03-19 | ||
|
|
||
| - Fix typos in readme | ||
| - Fix urrlib3 exception `urllib3.exceptions.ProxySchemeUnknown: Not supported proxy scheme None`, | ||
| - Fix imports | ||
|
|
||
| ## [1.0.0] - 2019-02-04 | ||
|
|
||
| - Initial release | ||
|
|
||
| ## License | ||
|
|
||
| --- | ||
|
|
||
| MIT | ||
|
|
||
| **Free Software!** | ||
| # Free-proxy | ||
|  | ||
|
|
||
|
|
||
| ## Get free working proxies from <https://www.sslproxies.org/>, <https://www.us-proxy.org/>, <https://free-proxy-list.net/uk-proxy.html> and <https://free-proxy-list.net> and use them in your script | ||
|
|
||
| The FreeProxy class scrapes proxies from <https://www.sslproxies.org/>, <https://www.us-proxy.org/>, <https://free-proxy-list.net/uk-proxy.html>, and <https://free-proxy-list.net> and checks to make sure that it works. | ||
| You can filter proxies by country, and specify an acceptable timeout. You can also randomize the list of proxies, rather than going in the order that they are scraped in. | ||
|
|
||
| You can use this to send requests through a custom proxy, with Selenium, or with anything else. | ||
|
|
||
| Returns proxy as string: | ||
|
|
||
| ```python | ||
| 'http://113.160.218.14:8888' | ||
| ``` | ||
|
|
||
| ### Requirements | ||
|
|
||
| - [Python 3](https://www.python.org/downloads/) | ||
| - [Requests library](https://github.com/psf/requests) | ||
| - [Lxml library](https://github.com/lxml/lxml) | ||
|
|
||
| ### Installation | ||
|
|
||
| ```python | ||
| pip install free-proxy | ||
| ``` | ||
|
|
||
| [](https://asciinema.org/a/Xolpn3eD2tyJl8Y8HE9zolgex) | ||
|
|
||
| ### Usage 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 | | ||
| | anonym | bool | True | False | | ||
| | elite | bool | True | False | | ||
| | google | bool,None | False | None | | ||
| | https | bool | True | False | | ||
|
|
||
| - **No parameters** | ||
| Get the first working proxy from <https://www.sslproxies.org/>. If no proxies are working, try again pulling from <https://free-proxy-list.net> | ||
|
|
||
| ```python | ||
| proxy = FreeProxy().get() | ||
| ``` | ||
|
|
||
| - **`country_id` parameter** | ||
| Get the first working proxy from a specified list of countries (from <https://www.sslproxies.org/>). If no proxies are working **check all countries** pulling from <https://free-proxy-list.net>. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(country_id=['US', 'BR']).get() | ||
| ``` | ||
|
|
||
| - **`country_id` for US and GB** | ||
| You can set the country_id to US or GB to get a proxy from the United States or the United Kingdom respectively. Proxies will be scrapped from <https://www.us-proxy.org/> (`US`) or <https://free-proxy-list.net/uk-proxy.html> (`GB`). If there are no working proxies in the specified list **check all countries** | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(country_id=['US']).get() | ||
| proxy = FreeProxy(country_id=['GB']).get() | ||
| ``` | ||
|
|
||
| - **`timeout` parameter** | ||
| Timeout is the parameter for checking if a proxy is valid. If the server does not respond in specified time, | ||
| the script will mark the proxy as invalid. Default `timeout=0.5`. You can change it by specifying a timeout eg. `timeout=1`. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(timeout=1).get() | ||
| ``` | ||
|
|
||
| - **`rand` parameter** | ||
| Shuffles the order of the proxy list from <https://www.sslproxies.org/> instead of going from newest to oldest (as listed on the website). Defaults to `rand=False` | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(rand=True).get() | ||
| ``` | ||
|
|
||
| - **`anonym` parameter** | ||
| Return only proxies marked as anonymous. Defaults to `anonym=False` | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(anonym=True).get() | ||
| ``` | ||
|
|
||
| - **`elite` parameter** | ||
| Return only proxies marked as 'elite proxy'. Defaults to `elite=False`. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(elite=True).get() | ||
| ``` | ||
|
|
||
| Please note: elite proxies are always anonymous. If you set `elite=True`, you will also be eliminating any non-anonymous proxies. | ||
|
|
||
| - **`google` parameter** | ||
| If `True` it will only return proxies marked as "google". If `False`, it will not return proxies marked as "google". Defaults to `google=None`, which returns all proxies. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(google=True).get() | ||
| ``` | ||
|
|
||
| - **`https` parameter** | ||
| If `True` it will only return proxies marked as HTTPS. Defaults to `https=False` - i.e. HTTP proxy (for HTTP websites). | ||
|
|
||
| Please note: HTTPS proxies work for both HTTP and HTTPS websites. | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(https=True).get() | ||
| ``` | ||
|
|
||
| You can combine parameters: | ||
|
|
||
| ```python | ||
| proxy = FreeProxy(country_id=['US', 'BR'], timeout=0.3, rand=True).get() | ||
| ``` | ||
|
|
||
| If there are no working proxies with the provided parameters, the script will raise `FreeProxyException` with the message `There are no working proxies at this time.`. | ||
|
|
||
| ## CHANGELOG | ||
|
|
||
| --- | ||
|
|
||
| ## [1.1.1] - 2023-02-18 | ||
|
|
||
| - Fixed https parameter error | ||
| - Fixed additional loop issue when no proxy was found | ||
|
|
||
| ## [1.1.0] - 2022-11-12 | ||
|
|
||
| - Added new website to get proxies from <https://free-proxy-list.net> | ||
| - Added new website to get proxies from <https://free-proxy-list.net/uk-proxy.html> | ||
| - Added new website to get proxies from <https://www.us-proxy.org/> | ||
| - Change lxml version to 4.9.1 | ||
|
|
||
| ## [1.0.6] - 2022-01-23 | ||
|
|
||
| - Added `google` parameter | ||
| - Added `https` parameter | ||
|
|
||
| ## [1.0.5] - 2022-01-07 | ||
|
|
||
| - Added `elite` parameter | ||
| - Add exception class and raise exception instead of system exit | ||
| - Change lxml version to 4.6.5 | ||
|
|
||
| ## [1.0.4] - 2021-11-13 | ||
|
|
||
| - Fix proxy list default length | ||
|
|
||
| ## [1.0.3] - 2021-08-18 | ||
|
|
||
| - Change XPatch due to SSL proxies page update | ||
| - Change lxml version | ||
|
|
||
| ## [1.0.2] - 2020-09-03 | ||
|
|
||
| - Added `anonym` parameter | ||
|
|
||
| ## [1.0.1] - 2020-03-19 | ||
|
|
||
| - Fix typos in readme | ||
| - Fix urrlib3 exception `urllib3.exceptions.ProxySchemeUnknown: Not supported proxy scheme None`, | ||
| - Fix imports | ||
|
|
||
| ## [1.0.0] - 2019-02-04 | ||
|
|
||
| - Initial release | ||
|
|
||
| ## License | ||
|
|
||
| --- | ||
|
|
||
| [MIT](https://github.com/jundymek/free-proxy/blob/master/LICENSE) | ||
|
|
||
| **Free Software!** |