Metadata-Version: 2.1
Name: proxies_scraper
Version: 0.1.0
Summary: A Python package for proxies scripting
Author-email: Carlosman1996 <cmmolinas01@gmail.com>
Project-URL: Homepage, https://github.com/Carlosman1996/proxies_scraper
Keywords: proxies,scripting,networking
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: beautifulsoup4==4.12.3
Requires-Dist: certifi==2024.7.4
Requires-Dist: charset-normalizer==3.3.2
Requires-Dist: idna==3.7
Requires-Dist: requests==2.32.3
Requires-Dist: soupsieve==2.5
Requires-Dist: urllib3==2.2.2
Provides-Extra: dev
Requires-Dist: isort; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: pytest; extra == "dev"

# Proxies Scraper

A Python package for searching free proxies. This package allows you to retrieve and filter proxy servers based on 
various criteria such as:
- Country code.
- Anonymity level.
- HTTP or HTTPS type.

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
  - [Basic Example](#basic-example)
  - [Advanced Example](#advanced-example)
- [Function Documentation](#function-documentation)
  - [`get_proxies`](#get_proxies)
- [Contributing](#contributing)
- [License](#license)

## Introduction

Proxies Scraper is a versatile Python package designed to help developers find and filter free proxy servers. 
It can be particularly useful for tasks such as web scraping, automated testing, and browsing with privacy.

## Features

- Filter proxies by country code.
- Filter proxies by anonymity level.
- Filter proxies by HTTP/HTTPS type.

## Installation

You can install the package using pip:

```sh
pip install proxies_scraper
```

## Usage

### Basic Example

Get a list of all proxies.

```python

from proxies_scraper.main import get_proxies

proxies = get_proxies()

print(proxies)
```

### Advanced Example

Get a proxies list filtered by country code and HTTPS support

```python

from proxies_scraper.main import get_proxies

proxies = get_proxies(
    country_codes_filter=['US'],
    anonymity_filter=[2],
    https_filter=True
)

for proxy in proxies:
    print(proxy)
```

## Contributing

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Implement your changes and ensure your code passes the tests.
4. Commit your changes with a descriptive commit message.
5. Push your changes to your forked repository.
6. Create a pull request to the main repository.

Please make sure your code adheres to the project's coding standards and includes appropriate tests.
