Initial commit

Author: 6C656C65

.bumpversion.cfg

@@ -0,0 +1,8 @@
+[bumpversion]
+current_version = 0.1.0
+commit = True
+tag = True
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"

.github/workflows/main.yml

@@ -0,0 +1,115 @@
+name: cicd
+
+on: 
+  push:
+    branches:
+      - main
+    tags:
+      - "*"
+  pull_request:
+
+jobs:
+  code-scan:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install --no-cache-dir -U pip black flake8 bandit
+
+      - name: Lint with flake8
+        run: flake8 pyproxy tests benchmark
+
+      - name: Check with black
+        run: black --check pyproxy tests benchmark
+
+      - name: Check with bandit
+        run: bandit -r pyproxy tests benchmark
+
+  unittest:
+    needs: code-scan
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      - name: Install build dependencies
+        run: pip install --no-cache-dir -r requirements.txt
+
+      - name: Run tests
+        run: python -m unittest discover -s tests
+
+  build-packages:
+    needs: unittest
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      - name: Get version
+        id: get_version
+        run: |
+          version=$(grep '^__version__' pyproxy_sdk/__init__.py | cut -d'"' -f2)
+          echo "version=${version}" >> $GITHUB_OUTPUT
+
+      - name: Create Tag
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag v${{ steps.get_version.outputs.version }}
+          git push origin v${{ steps.get_version.outputs.version }}
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: actions/create-release@v1
+        with:
+          tag_name: v${{ steps.get_version.outputs.version }}
+          release_name: Release v${{ steps.get_version.outputs.version }}
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install build dependencies
+        run: pip install --no-cache-dir -U pip . build
+
+      - name: Build package
+        run: python -m build --sdist --wheel
+      - name: Upload built distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Install release dependencies
+        run: pip install --no-cache-dir -U pip . twine packaging
+
+      - name: Upload to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -0,0 +1,171 @@
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

examples/add_domain.py

@@ -0,0 +1,15 @@
+from pyproxy_sdk.client import PyProxyClient
+from pyproxy_sdk.exceptions import PyProxyAlreadyExists
+
+# Create client
+client = PyProxyClient(
+    base_url="http://localhost:5000",
+    username="admin",
+    password="password",
+)
+
+# Add domain to blocklist
+try:
+    client.add_filtering("domain", "example.com")
+except PyProxyAlreadyExists:
+    print("This domain is already blocked.")

examples/add_url.py

@@ -0,0 +1,15 @@
+from pyproxy_sdk.client import PyProxyClient
+from pyproxy_sdk.exceptions import PyProxyAlreadyExists
+
+# Create client
+client = PyProxyClient(
+    base_url="http://localhost:5000",
+    username="admin",
+    password="password",
+)
+
+# Add URLs to blocklist
+try:
+    client.add_filtering("url", "example.com/test")
+except PyProxyAlreadyExists:
+    print("This URLs is already blocked.")

examples/create_client.py

@@ -0,0 +1,8 @@
+from pyproxy_sdk.client import PyProxyClient
+
+# Create client
+client = PyProxyClient(
+    base_url="http://localhost:5000",
+    username="admin",
+    password="password",
+)

examples/create_client_with_timeout.py

@@ -0,0 +1,9 @@
+from pyproxy_sdk.client import PyProxyClient
+
+# Create client
+client = PyProxyClient(
+    base_url="http://localhost:5000",
+    username="admin",
+    password="password",
+    timeout=5,
+)

examples/delete_domain.py

@@ -0,0 +1,15 @@
+from pyproxy_sdk.client import PyProxyClient
+from pyproxy_sdk.exceptions import PyProxyNotFound
+
+# Create client
+client = PyProxyClient(
+    base_url="http://localhost:5000",
+    username="admin",
+    password="password",
+)
+
+# Delete domain from blocklist
+try:
+    client.delete_filtering("domain", "example.com")
+except PyProxyNotFound:
+    print("This domain is not blocked.")

examples/delete_url.py

@@ -0,0 +1,15 @@
+from pyproxy_sdk.client import PyProxyClient
+from pyproxy_sdk.exceptions import PyProxyNotFound
+
+# Create client
+client = PyProxyClient(
+    base_url="http://localhost:5000",
+    username="admin",
+    password="password",
+)
+
+# Delete URL from blocklist
+try:
+    client.delete_filtering("url", "example.com/test")
+except PyProxyNotFound:
+    print("This URL is not blocked.")

examples/get_filtering_rules.py

@@ -0,0 +1,13 @@
+from pyproxy_sdk.client import PyProxyClient
+from pyproxy_sdk.exceptions import PyProxyAlreadyExists, PyProxyNotFound
+
+# Create client
+client = PyProxyClient(
+    base_url="http://localhost:5000",
+    username="admin",
+    password="password",
+)
+
+# Get filtering rules
+filters = client.get_filtering()
+print(filters)