proxar 0.1.2__py3-none-any.whl

proxar/__init__.py

@@ -0,0 +1,17 @@
+import logging
+
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
+
+
+class Proxar:
+    """A Python client for fetching public proxies.
+
+    This library provides an asynchronous, easy-to-use interface to
+    retrieve fresh proxies, handling the complexities of web scraping
+    and source aggregation.
+    """
+
+    def __init__(self) -> None:
+        """Initialize the Proxar instance."""
+        logger.info("Proxar instance has been initialized.")

proxar-0.1.2.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: proxar
+Version: 0.1.2
+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
+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 Proxy Fetching:** Retrieves proxies from several providers.
+- **Asynchronous Architecture:** Built entirely on `asyncio` and `aiohttp` for efficient, non-blocking network operations.
+- **Platform-Aware Storage:** Uses `platformdirs` to store proxies in the appropriate user-specific data directory on any OS, with an option for users to specify a custom path.
+- **Simple Text-Based Storage:** Saves proxies to simple `.txt` files, making them easy to read, parse, and share.
+- **Configurable Logging:** Provides detailed logging for monitoring and debugging.
+
+---
+
+## 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/your-username/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 a basic example of how to use Proxar to fetch proxies:
+
+```python
+import asyncio
+from proxar import Proxar
+
+async def main():
+    # Initialize Proxar
+    # You can optionally provide a custom storage path:
+    # proxar = Proxar(storage_path="/path/to/your/proxies")
+    proxar = Proxar()
+
+    try:
+        # Fetch proxies from all configured sources
+        await proxar.get_proxies()
+        print("Proxy fetching complete.")
+        print(f"Proxies saved to: {proxar.storage_path}")
+
+    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_path` argument during initialization.
+-   **Logging:** Logging levels and output can be configured within the library's logging module.
+
+---
+
+## 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).

proxar-0.1.2.dist-info/RECORD

@@ -0,0 +1,5 @@
+proxar/__init__.py,sha256=X2ttuG_9U20-B_lQl4utBikcLmTgeSLo3jRuu06EOAs,477
+proxar-0.1.2.dist-info/METADATA,sha256=LA_Ril7pb2efXIrdbRqECBNIRBBfGgg6Mi5pjCDJKaw,4952
+proxar-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+proxar-0.1.2.dist-info/licenses/LICENSE,sha256=nADWCkou8O88YlL98Q9yVUXMJmusPE4LlQRrTv7S0Ts,1064
+proxar-0.1.2.dist-info/RECORD,,

proxar-0.1.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

proxar-0.1.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+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.