Metadata-Version: 2.1
Name: proxy-checker-httpx
Version: 0.6.0
Summary: Proxy checker in Python
Author: Maehdakvan
Project-URL: Source Code, https://github.com/DedInc/proxy-checker-python
Keywords: proxy checker
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: httpx

# Proxy Checker (Python)

[![Downloads](https://pepy.tech/badge/proxy-checker-httpx)](https://pepy.tech/project/proxy-checker-httpx)

A proxy checker in Python using Requests.

## Description

The proxy checker takes a proxy as input and uses it to send a request to a proxy judge (a website that outputs the information that was sent to it). If the request succeeds, the proxy checker will use the information it receives from the proxy judge to determine the proxy's:

- Country
- Protocol
- Anonymity
- Speed

## Installation

```console
pip install proxy-checker-httpx
```

## Usage

```python3
from proxy_checker_httpx import ProxyChecker
import asyncio

async def main():
  checker = ProxyChecker()
  await checker.initialize()
  await checker.check_proxy('<ip>:<port>')
  return

asyncio.run(main())
```

```json
{
  "country": "United States",
  "country_code": "US",
  "protocols": ["socks4", "socks5"],
  "anonymity": "Elite",
  "timeout": 1649
}
```

## Parameters

| Name          | Type | Default | Description                                          |
| ------------- | ---- | ------- | ---------------------------------------------------- |
| proxy         | str  |         | The proxy to test                                    |
| check_country | bool | True    | If `true`, the proxy's country will be looked up     |
| check_address | bool | False   | If `true`, the proxy's remote address will looked up |
| user          | str  | None    | The proxy's username                                 |
| password      | str  | None    | The proxy's password                                 |

## Requirements

- Python 3.\*
- [Httpx](https://pypi.org/project/httpx/) - A httpx python module \*

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](LICENSE.md)
