Metadata-Version: 2.4
Name: proxar
Version: 0.7.0
Summary: A Python client for fetching public proxies from multiple sources.
Project-URL: Homepage, https://github.com/filming/proxar
Project-URL: Repository, https://github.com/filming/proxar
Project-URL: Issues, https://github.com/filming/proxar/issues
Project-URL: Changelog, https://github.com/filming/proxar/blob/master/CHANGELOG.md
Author: Filming
License: MIT License
        
        Copyright (c) 2024 filming
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: asyncio,proxies,proxy,python,python3,web-scraping
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: aiofiles>=24.1.0
Requires-Dist: aiohttp>=3.12.13
Requires-Dist: beautifulsoup4>=4.13.4
Requires-Dist: lxml>=6.0.0
Requires-Dist: platformdirs>=4.3.8
Requires-Dist: types-aiofiles>=24.1.0.20250606
Description-Content-Type: text/markdown

# Proxar

Proxar is a Python client for fetching public proxies from various online sources.

It uses an asynchronous architecture to retrieve fresh proxies from multiple providers, providing a stream of proxies for use in web scraping, data analysis, and other network-intensive tasks.

---

## Features

- **Multi-Source Aggregation:** Fetches and aggregates proxies from a diverse set of public sources, including web pages and APIs.
- **Asynchronous Architecture:** Built on `asyncio` and `aiohttp` for high-performance, non-blocking network operations.
- **Flexible Usage:** Choose to have proxies saved directly to a file or returned as a Python dictionary for immediate use.
- **Atomic JSON Storage:** Safely saves proxies to a single `proxies.json` file, preventing data corruption with atomic write operations.
- **Platform-Aware Storage:** Uses `platformdirs` to store proxies in the appropriate user-specific data directory, but allows overriding with a custom path.
- **Persistent Session:** Loads previously fetched proxies at startup to maintain a persistently unique and growing list across sessions.

---

## Installation

### From PyPI (Recommended)

```bash
pip install proxar
```

### From Source

You can set up Proxar by cloning the repository directly.

1.  Clone the repository:
    ```bash
    git clone https://github.com/filming/proxar.git
    cd proxar
    ```
2.  Install the project and its dependencies:
    ```bash
    pip install -e .
    ```
    - To install development dependencies like `mypy` and `ruff`, use:
    ```bash
    pip install -e .[dev]
    ```

---

## Usage

Here’s how to use Proxar to fetch proxies. You can either save them to a file or work with them directly.

```python
import asyncio
from proxar import Proxar

async def main():
    # Initialize Proxar.
    # By default, it uses a platform-specific data directory.
    # You can provide a custom path, e.g., Proxar(storage_dir="path/to/proxies")
    proxar = Proxar()

    try:
        # --- Example 1: Save proxies to a file (default behavior) ---
        print("Fetching proxies and saving to file...")
        await proxar.get_proxies(save_to_file=True)
        print("Proxy fetching and saving complete.")
        # Proxies are saved in proxies.json inside the storage directory.

        # --- Example 2: Get proxies as a dictionary ---
        print("\nFetching proxies and returning them directly...")
        proxies = await proxar.get_proxies(save_to_file=False)
        if proxies:
            http_proxies = proxies.get("http", [])
            print(f"Fetched {len(http_proxies)} HTTP proxies.")
            # print("First 5 HTTP proxies:", http_proxies[:5])

    except Exception as e:
        print(f"An error occurred: {e}")

if __name__ == "__main__":
    asyncio.run(main())
```

---

## Configuration

Proxar is designed to work out-of-the-box with minimal configuration.

-   **Storage:** By default, Proxar stores fetched proxies in a `proxar` directory inside your user data folder. You can override this by passing a `storage_dir` argument during initialization.
-   **Logging:** The library uses the standard `logging` module. You can configure the root logger in your application to control the log level and output format.

---

## Dependencies

All project dependencies are managed via [`pyproject.toml`](pyproject.toml).

---

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

## Contributing

Contributions, bug reports, and feature requests are welcome!
Please open an issue or submit a pull request on [GitHub](https://github.com/filming/proxar).
