proxar 0.1.2__tar.gz

proxar-0.1.2/.github/workflows/release.yml

@@ -0,0 +1,76 @@
+name: Release and Publish
+
+on:
+  push:
+    branches:
+      - main
+
+# Cancel pending runs of the workflow for the same branch
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  release:
+      # Prevent the workflow from running on its own commits
+      if: ${{ !contains(github.event.head_commit.message, 'chore(release):') }}
+      runs-on: ubuntu-latest
+      name: "Bump version, create changelog, and publish"
+      permissions:
+        contents: write
+        id-token: write
+
+      steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install commitizen hatch
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Create Bump and Changelog
+        id: cz
+        run: |
+          cz bump --changelog --yes
+          echo "tag=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
+
+      - name: Push changes to main
+        run: git push origin main --tags
+
+      - name: Get Changelog Entry
+        id: changelog
+        run: |
+          CHANGELOG_CONTENT=$(awk '
+            /^## v/ { if (p) exit; p=1; next }
+            p { print }
+          ' CHANGELOG.md)
+
+          echo "content<<EOF" >> $GITHUB_OUTPUT
+          echo "$CHANGELOG_CONTENT" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.cz.outputs.tag }}
+          body: ${{ steps.changelog.outputs.content }}
+
+      - name: Build package
+        run: hatch build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

proxar-0.1.2/.gitignore

@@ -0,0 +1,16 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# macOS files
+.DS_Store
+
+# Personal
+devarea/

proxar-0.1.2/.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.1
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: [--fix]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.16.1
+    hooks:
+      - id: mypy
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.8.3
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]

proxar-0.1.2/.python-version

@@ -0,0 +1 @@
+3.10

proxar-0.1.2/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to Xify will be documented in this file.
+
+## v0.1.2 (2025-06-29)
+
+### Bug Fixes
+
+- change gitignore order
+
+## v0.1.1 (2025-06-29)
+
+### Bug Fixes
+
+- issue publishing package to pypi
+
+## v0.1.0 (2025-06-29)
+
+### Features
+
+- add main class

proxar-0.1.2/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.

proxar-0.1.2/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,100 @@
+# 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/pyproject.toml

@@ -0,0 +1,82 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "proxar"
+version = "0.1.2"
+description = "A Python client for fetching public proxies from multiple sources."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = []
+license = {file = "LICENSE"}
+authors = [
+    {name = "Filming"}
+]
+keywords = ["python", "python3", "proxy", "proxies", "web-scraping", "asyncio"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+[project.urls]
+Homepage = "https://github.com/filming/proxar"
+Repository = "https://github.com/filming/proxar"
+Issues = "https://github.com/filming/proxar/issues"
+Changelog = "https://github.com/filming/proxar/blob/master/CHANGELOG.md"
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "PL", "B", "SIM", "C90"]
+ignore = []
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.isort]
+known-first-party = ["proxar"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+strict = true
+files = ["src"]
+python_version = "3.10"
+
+[tool.pdm.scripts]
+format = "uv run ruff format src"
+check_fix = "uv run ruff check --fix src"
+type_check = "uv run mypy src"
+clean = { composite = ["format", "check_fix", "type_check"] }
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/proxar"]
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "v$version"
+version_scheme = "pep440"
+version_provider = "uv"
+update_changelog_on_bump = true
+changelog_message_builder_hook = "commitizen.hooks.conventional_commits_message_builder_hook"
+change_type_map = { "feat" = "Features", "fix" = "Bug Fixes", "perf" = "Performance Improvements", "refactor" = "Code Refactoring", "build" = "Build System", "ci" = "Continuous Integration", "docs" = "Documentation", "style" = "Styles", "test" = "Tests", "chore" = "Chores" }
+
+[dependency-groups]
+dev = [
+    "commitizen>=4.8.3",
+    "mypy>=1.16.1",
+    "pdm>=2.25.3",
+    "pre-commit>=4.2.0",
+    "ruff>=0.12.1",
+]

proxar-0.1.2/src/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.")