Initial commit

Author: 6C656C65

.github/workflows/main.yml

@@ -0,0 +1,31 @@
+name: cicd
+
+on: 
+  push:
+  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 ruff
+
+      - name: Lint and security check with Ruff
+        run: ruff check
+
+      - name: Check code formatting with Ruff
+        run: ruff format --check

.gitignore

@@ -0,0 +1,178 @@
+# 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
+
+
+.vscode
+.ruff_cache
+
+outputs/*.html
+!outputs/*example.html

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.14.0
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format

README.md

@@ -0,0 +1,94 @@
+# 🏎️ Benchmark for pyproxy
+
+This benchmarking tool is designed to measure the performance of **pyproxy** in handling HTTP and HTTPS requests. It allows you to compare the average, maximum, and minimum request times both with and without the proxy.
+
+---
+
+## 📦 **Installation**
+
+### Install dependencies
+Before running the benchmark, you need to install the required dependencies. You can do so by running the following command:
+```bash
+pip install -r benchmark/requirements.txt
+```
+
+---
+
+## 🚀 **Usage**
+
+### Start the Proxy
+Before running the benchmark, ensure that **pyproxy** is running. Start the proxy by running:
+```bash
+python3 -m pyproxy
+```
+The proxy will be available at `0.0.0.0:8080`.
+
+### Run the benchmark
+Once the proxy is up and running, execute the following command from the root of the project to start the benchmark:
+```bash
+python3 benchmark/benchmark.py --target-file benchmark/urls.txt
+```
+
+This will run the benchmark using the URLs listed in `benchmark/urls.txt` and generate a report on the request times, comparing the proxy performance (with and without the proxy).
+
+### Customizing the URLs and Requests
+
+- You can modify the `benchmark/urls.txt` file to add multiple URLs that you want to benchmark. Each line should contain a URL.
+  
+- Alternatively, you can test a single URL by using the `--target-url` argument. For example:
+  ```bash
+  python3 benchmark/benchmark.py --target-url http://example.com
+  ```
+
+- You can also change the number of requests made during the benchmark using the `--num-requests` argument. By default, it tests 100 requests per URL, but you can adjust it like this:
+  ```bash
+  python3 benchmark/benchmark.py --target-file benchmark/urls.txt --num-requests 50
+  ```
+  This will test 50 requests per URL instead of the default 10.
+
+---
+
+## 📊 **Benchmark Results**
+
+The benchmarking script will produce a table comparing the average, maximum, and minimum request times for each URL, as well as a breakdown into the following columns:
+
+- **With Proxy**:
+  - **Avg**: Average request time with the proxy.
+  - **Max**: Maximum request time with the proxy.
+  - **Min**: Minimum request time with the proxy.
+  
+- **Without Proxy**:
+  - **Avg**: Average request time without the proxy.
+  - **Max**: Maximum request time without the proxy.
+  - **Min**: Minimum request time without the proxy.
+
+The detailed report will be available in the `outputs` directory as a file named `benchmark_combined_report_<timestamp>.html`. You can open this HTML file in a browser to view the results.
+
+## 📈 **Example Benchmark Results**
+
+### Global Proxy Performance Summary
+
+| **Metric**                          | **Value**           |
+|--------------------------------------|--------------------|
+| Global average without proxy         | 0.341067 seconds   |
+| Global average with proxy            | 0.414619 seconds   |
+| Impact (Slowdown)                    | 21.57%             |
+
+### Benchmark Results Summary
+
+| **URL**               | **Avg (s)** | **Min (s)** | **Max (s)** | **Avg with Proxy (s)** | **Min with Proxy (s)** | **Max with Proxy (s)** |
+|-----------------------|-------------|-------------|-------------|-------------------------|-------------------------|-------------------------|
+| `http://example.com`  | 0.24766     | 0.19376     | 0.30262     | 0.27064                 | 0.19926                 | 0.30419                 |
+| `https://example.com` | 0.43447     | 0.33968     | 0.48372     | 0.55860                 | 0.41271                 | 0.67175                 |
+
+---
+
+### Example Reports 
+
+Example reports can be found in the following files:
+- [Interactive Report Example](outputs/benchmark_combined_interactive_example.html)
+- [Report Example](outputs/benchmark_combined_report_example.html)
+
+These files contain example benchmark results and interactive graphs.
+
+---