swiftshadow 1.2.1__tar.gz → 2.0.0__tar.gz

swiftshadow-2.0.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @sachin-sankar

swiftshadow-2.0.0/.github/workflows/pyfix.yml

@@ -0,0 +1,57 @@
+name: Lint
+
+on:
+
+  # Trigger the workflow on push or pull request,
+
+  # but only for the main branch
+
+  push:
+
+    branches:
+
+      - main
+
+  pull_request:
+
+    branches:
+
+      - main
+
+jobs:
+
+  run-linters:
+
+    name: Run linters
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Check out Git repository
+
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+
+        uses: actions/setup-python@v1
+
+        with:
+
+          python-version: 3.8
+
+      - name: Install Python dependencies
+
+        run: pip install black flake8
+
+      - name: Run linters
+
+        uses: wearerequired/lint-action@v2
+
+        with:
+
+          auto_fix: true
+
+          black: true
+
+          black_auto_fix: true

swiftshadow-2.0.0/.github/workflows/python-publish-manual.yml

@@ -0,0 +1,37 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on: workflow_dispatch
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

swiftshadow-2.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,40 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

swiftshadow-2.0.0/.gitignore

@@ -0,0 +1,142 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# End of https://mrkandreev.name/snippets/gitignore-generator/#Python
+.swiftshadow.json
+poetry.lock

swiftshadow-2.0.0/.python-version

@@ -0,0 +1 @@
+3.12

swiftshadow-2.0.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: swiftshadow
+Version: 2.0.0
+Summary: Free IP Proxy rotator for python
+Author-email: sachin-sankar <mail.sachinsankar@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.11.11
+Requires-Dist: appdirs>=1.4.4
+Requires-Dist: requests>=2.32.3
+Description-Content-Type: text/markdown
+
+# Swiftshadow
+
+![PyPI - Downloads](https://img.shields.io/pypi/dm/swiftshadow)  
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/sachin-sankar/swiftshadow?include_prereleases&style=flat)
+
+> [!WARNING]  
+> **Heads up!** If you're using **versions 1.2.1 or below**, please note that **version 2.0.0 and above** includes breaking changes. Before upgrading, read the [documentation](https://sachin-sankar.github.io/swiftshadow/) to understand the changes and ensure compatibility with your code. If you encounter issues, please review the docs before opening a GitHub issue.
+
+## About
+
+**Swiftshadow** is a lightweight and efficient Python library designed to simplify IP proxy rotation for web scraping, data mining, and other automated tasks. It helps you bypass common challenges like IP bans, rate limits, and detection mechanisms, ensuring smooth and uninterrupted data collection.
+
+### Key Features
+- **Speed**: Optimized for fast proxy retrieval and rotation.
+- **Reliability**: Automatically switches to working proxies if one fails.
+- **Customization**: Configure proxy filters, rotation frequency, and caching behavior.
+- **Low Dependencies**: Only one third-party dependency (`requests`), making it easy to use and maintain.
+- **Caching**: Built-in caching mechanism to reduce load times and improve performance.
+
+Whether you're a seasoned developer or a beginner, **Swiftshadow** makes proxy management effortless.
+
+---
+
+## Installation
+
+Install the library using pip:
+
+```bash
+pip install swiftshadow
+```
+
+---
+
+## Quick Start
+
+### Get a Proxy in 2 Lines
+Fetch a random proxy with just two lines of code:
+
+```python
+from swiftshadow import QuickProxy
+
+print(QuickProxy())  # Output: http://<ip>:<port>
+```
+
+### Advanced Usage
+For more control, use the `ProxyInterface` class:
+
+```python
+from swiftshadow.classes import ProxyInterface
+
+# Fetch HTTPS proxies from the US
+swift = ProxyInterface(countries=["US"], protocol="https")
+print(swift.get().as_string())  # Output: https://<ip>:<port>
+```
+
+---
+
+## Documentation
+
+Explore the full documentation to learn more about **Swiftshadow**'s features and advanced usage:
+
+📚 [Documentation](https://sachin-sankar.github.io/swiftshadow/)
+
+---
+
+## Why Swiftshadow?
+
+- **Lightweight**: Minimal dependencies and easy to integrate.
+- **Flexible**: Supports filtering by country and protocol.
+- **Scalable**: Ideal for both small scripts and large-scale scraping projects.
+- **Open Source**: Free to use, modify, and contribute to under the MIT License.
+
+---
+
+## Contributing
+
+Contributions are welcome! If you'd like to improve **Swiftshadow**, feel free to open an issue or submit a pull request on [GitHub](https://github.com/sachin-sankar/swiftshadow).
+
+---
+
+## License
+
+**Swiftshadow** is licensed under the MIT License. See the [LICENSE](https://github.com/sachin-sankar/swiftshadow/blob/main/LICENSE) file for details.

swiftshadow-2.0.0/README.md

@@ -0,0 +1,83 @@
+# Swiftshadow
+
+![PyPI - Downloads](https://img.shields.io/pypi/dm/swiftshadow)  
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/sachin-sankar/swiftshadow?include_prereleases&style=flat)
+
+> [!WARNING]  
+> **Heads up!** If you're using **versions 1.2.1 or below**, please note that **version 2.0.0 and above** includes breaking changes. Before upgrading, read the [documentation](https://sachin-sankar.github.io/swiftshadow/) to understand the changes and ensure compatibility with your code. If you encounter issues, please review the docs before opening a GitHub issue.
+
+## About
+
+**Swiftshadow** is a lightweight and efficient Python library designed to simplify IP proxy rotation for web scraping, data mining, and other automated tasks. It helps you bypass common challenges like IP bans, rate limits, and detection mechanisms, ensuring smooth and uninterrupted data collection.
+
+### Key Features
+- **Speed**: Optimized for fast proxy retrieval and rotation.
+- **Reliability**: Automatically switches to working proxies if one fails.
+- **Customization**: Configure proxy filters, rotation frequency, and caching behavior.
+- **Low Dependencies**: Only one third-party dependency (`requests`), making it easy to use and maintain.
+- **Caching**: Built-in caching mechanism to reduce load times and improve performance.
+
+Whether you're a seasoned developer or a beginner, **Swiftshadow** makes proxy management effortless.
+
+---
+
+## Installation
+
+Install the library using pip:
+
+```bash
+pip install swiftshadow
+```
+
+---
+
+## Quick Start
+
+### Get a Proxy in 2 Lines
+Fetch a random proxy with just two lines of code:
+
+```python
+from swiftshadow import QuickProxy
+
+print(QuickProxy())  # Output: http://<ip>:<port>
+```
+
+### Advanced Usage
+For more control, use the `ProxyInterface` class:
+
+```python
+from swiftshadow.classes import ProxyInterface
+
+# Fetch HTTPS proxies from the US
+swift = ProxyInterface(countries=["US"], protocol="https")
+print(swift.get().as_string())  # Output: https://<ip>:<port>
+```
+
+---
+
+## Documentation
+
+Explore the full documentation to learn more about **Swiftshadow**'s features and advanced usage:
+
+📚 [Documentation](https://sachin-sankar.github.io/swiftshadow/)
+
+---
+
+## Why Swiftshadow?
+
+- **Lightweight**: Minimal dependencies and easy to integrate.
+- **Flexible**: Supports filtering by country and protocol.
+- **Scalable**: Ideal for both small scripts and large-scale scraping projects.
+- **Open Source**: Free to use, modify, and contribute to under the MIT License.
+
+---
+
+## Contributing
+
+Contributions are welcome! If you'd like to improve **Swiftshadow**, feel free to open an issue or submit a pull request on [GitHub](https://github.com/sachin-sankar/swiftshadow).
+
+---
+
+## License
+
+**Swiftshadow** is licensed under the MIT License. See the [LICENSE](https://github.com/sachin-sankar/swiftshadow/blob/main/LICENSE) file for details.