Compare commits

..
64 Commits
Author SHA1 Message Date
ThePhaseless 849e33dff3 use timer to timeout functions 2025-09-11 20:26:11 +00:00
ThePhaseless d25ce2ad94 add icon 2025-09-11 17:10:28 +00:00
ThePhaseless d78b1df041 change healthcheck msg 2025-09-11 16:55:05 +00:00
ThePhaseless c66d4e7084 return 200 if intersite challenge 2025-09-11 16:54:50 +00:00
ThePhaseless 9183a74fc3 use maxsize instead of power 2025-09-11 16:54:19 +00:00
ThePhaseless d29666151d dont build on pull request 2025-09-11 18:25:04 +02:00
renovate[bot] 2216d28e62 chore(deps): update dependency ruff to ==0.13.* (#239)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-09-11 01:53:53 +00:00
ThePhaseless 9ffc2bb5b3 fix exception 2025-09-10 20:47:59 +00:00
ThePhaseless 5f053ecd29 add logger for lib if debug 2025-09-10 22:46:03 +02:00
ThePhaseless 91e5279818 log loglevel 2025-09-10 22:45:55 +02:00
ThePhaseless 258f0bdbad add faster turnstile check 2025-09-10 22:45:40 +02:00
ThePhaseless f98e823991 Migrate to camoufox (#235)
* use camoufox

* build custom branches

* organize compose

* ignore missing stubs

* add init method

* create ADDON PATH

* check if solving is required

* type checking and remove logger

* uv sync

* add timeout

* add descriptiuon

* cancel previous runs

* wildcard minor

* fix proxy

* syntax fix

* [skip ci] fix loop warning

* fix proxy format

* copy over docker ignore

* remove testing line

* comment out port expose

* remove idope

* use strict typechecking

* refactor

* adjust compose

* run init only before test

* try test without init

* add curl

* handle page response

* remove turnsile test

* fix dockerignore symlink

* use newer debian

* bump pytest

* add docker in docker in devcontaienr

* remove unused values

* handle timeouts

* fix edgecase

* use new envs for proxy

* remove init command

* remove testing line

* remove setuptools

* fix linters

* reimport

* readd setuptools

* better float handling
2025-09-05 23:08:35 +02:00
renovate[bot] ff49ccb08b fix(deps): update dependency seleniumbase to v4.41.3 (#234)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-31 13:33:01 +00:00
renovate[bot] 7cae16ff63 fix(deps): update dependency seleniumbase to v4.41.2 (#233)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-27 17:33:26 +00:00
renovate[bot] 34e74b1f7b chore(deps): update dependency seleniumbase to v4.41.1 (#226)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 22:45:50 +00:00
ThePhaseless d4c058e7dc use trixie as base 2025-08-17 03:19:10 +02:00
ThePhaseless efcd8f0798 Merge pull request #225 from ThePhaseless/renovate/actions-checkout-5.x
chore(deps): update actions/checkout action to v5
2025-08-17 02:39:46 +02:00
ThePhaseless 4ab174243c fix exception 2025-08-17 00:38:37 +00:00
ThePhaseless d4e314e6f9 Merge pull request #228 from ThePhaseless/fix-cloudflare-errors
Fix Cloudfare errors
2025-08-17 01:20:13 +02:00
ThePhaseless b29e4c826e cancel previous runs 2025-08-16 22:50:10 +00:00
ThePhaseless 4ab01abbf0 ignore regex syntax warning 2025-08-16 22:49:24 +00:00
ThePhaseless 834cb76241 Merge branch 'main' into fix-cloudflare-errors 2025-08-16 22:43:12 +00:00
ThePhaseless 858bba598f bump deps 2025-08-16 22:41:26 +00:00
ThePhaseless 27beceaf4d update example compose file 2025-08-16 22:41:22 +00:00
renovate[bot] eb07de7421 fix(deps): update dependency seleniumbase to v4.41.0 (#3)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-16 17:32:57 +00:00
renovate[bot] 7348c0f19b chore(deps): update dependency ruff to v0.12.9 (#2)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-16 16:12:55 +00:00
Alvaro Santos Andres 6e1c073a6f fix: set default CAPTCHA_RETRIES to 3 2025-08-12 07:16:33 +02:00
renovate[bot] 1e443c2dbb chore(deps): update actions/checkout action to v5 2025-08-11 13:34:58 +00:00
Alvaro Santos Andres b153d4ae34 fix: simplify code to fix PR suggestions 2025-08-11 06:57:42 +00:00
Alvaro Santos Andres a3fec4c584 chore: fix renovate in a fork 2025-08-09 16:13:31 +00:00
renovate[bot] bf8e8ae20f chore(deps): update dependency ruff to v0.12.8 (#224)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-07 23:24:17 +00:00
Alvaro Santos Andres ddd325ae29 Merge remote-tracking branch 'upstream/main' 2025-08-07 08:17:08 +02:00
ThePhaseless b1704589ae [skip ci] Clarify questions 2025-08-06 23:56:41 +02:00
ThePhaseless 6fa5fceff1 [skip ci] Clarify some questions 2025-08-06 23:54:47 +02:00
ThePhaseless 9ef7a3d3ae Redefine "drop in replacement"
fixes #214
2025-08-06 23:21:40 +02:00
ThePhaseless 9eac1f872d Merge pull request #221 from mdallaire/main
feat(docker): add support for HOST env
2025-08-06 23:16:26 +02:00
Alvaro Santos Andres d5c250c647 chore: enable renovate 2025-08-05 06:58:56 +02:00
renovate[bot] e150b1a122 fix(deps): update dependency seleniumbase to v4.40.8 (#222)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-05 00:57:59 +00:00
Mathieu Dallaire 117c9bdd95 update readme 2025-08-04 11:27:27 -04:00
Mathieu Dallaire a3cd9815bd fix env 2025-08-04 10:56:01 -04:00
Mathieu Dallaire 73752f89c8 feat(docker): add support for HOST env 2025-08-04 10:35:49 -04:00
renovate[bot] c1dfec8c4d fix(deps): update dependency fastapi to v0.116.1 (#211)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-03 14:15:08 +00:00
renovate[bot] 64cefb7396 chore(deps): update dependency pytest-asyncio to v1.1.0 (#215)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-03 09:33:15 +00:00
renovate[bot] ab887df97f chore(deps): update dependency ruff to v0.12.7 (#213)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-03 05:44:30 +00:00
renovate[bot] c5fbc9c363 chore(deps): update dependency deptry to v0.23.1 (#219)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-03 00:48:14 +00:00
renovate[bot] 8178f646c0 fix(deps): update dependency seleniumbase to v4.40.7 (#212)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-02 21:00:28 +00:00
Alvaro Santos Andres 707a9c7a83 fix: use of CDP Mode 2025-07-25 16:31:28 +00:00
Alvaro Santos Andres 183f4f7f0f fix: enable reload to debug errors (2) 2025-07-25 15:19:05 +00:00
Alvaro Santos Andres 23d606a701 fix: enable reload to debug errors 2025-07-25 14:59:57 +00:00
Alvaro Santos Andres 6b0da3cc5e fix: add more logging to debug errors 2025-07-25 14:38:22 +00:00
Alvaro Santos Andres 39f758859d fix: disabled HEADLESS mode by default and updated dependencies 2025-07-25 13:51:19 +02:00
renovate[bot] 6fa0658f4c fix(deps): update dependency seleniumbase to v4.40.0 (#210)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-07-04 05:40:47 +00:00
renovate[bot] d13ab99344 chore(deps): update dependency ruff to v0.12.2 (#209)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-07-04 03:34:17 +00:00
renovate[bot] c9bcdd6099 fix(deps): update dependency seleniumbase to v4.39.6 (#208)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-07-02 05:28:46 +00:00
renovate[bot] 2263886efe fix(deps): update dependency uvicorn to v0.35.0 (#207)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-28 21:39:11 +00:00
renovate[bot] 5d3ddd9486 fix(deps): update dependency fastapi to v0.115.14 (#205)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-27 07:46:59 +00:00
renovate[bot] a2daf5a1e0 chore(deps): update dependency ruff to v0.12.1 (#206)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-27 03:34:05 +00:00
renovate[bot] 96d1bdd30f fix(deps): update dependency seleniumbase to v4.39.5 (#203)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-18 01:35:16 +00:00
renovate[bot] d275c56a8d chore(deps): update dependency ruff to v0.12.0 (#202)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-17 23:15:26 +00:00
renovate[bot] 09a23ddeb3 fix(deps): update dependency fastapi to v0.115.13 (#201)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-17 18:52:42 +00:00
renovate[bot] 3c99483a49 fix(deps): update dependency pydantic to v2.11.7 (#200)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-14 13:47:57 +00:00
renovate[bot] 2223bf722d fix(deps): update dependency pydantic to v2.11.6 (#199)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-13 15:13:25 +00:00
renovate[bot] 066a6d5f09 fix(deps): update dependency seleniumbase to v4.39.4 (#198)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-13 00:31:49 +00:00
renovate[bot] 128a0301f6 fix(deps): update dependency seleniumbase to v4.39.3 (#195)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-06-10 09:37:17 +00:00
20 changed files with 1179 additions and 819 deletions
+7 -1
View File
@@ -6,6 +6,7 @@
"dockerfile": "../Dockerfile",
"target": "devcontainer"
},
"runArgs": ["--security-opt", "label=disable", "--privileged"],
"customizations": {
"vscode": {
"extensions": ["charliermarsh.ruff", "ms-python.python"],
@@ -14,5 +15,10 @@
}
}
},
"postCreateCommand": "uv sync --group test && cd .venv/lib/*/site-packages/seleniumbase/drivers && rm -f uc_driver && ln -s /usr/bin/chromedriver uc_driver"
"postCreateCommand": "uv sync --group test",
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:2": {
"moby": false
}
}
}
+10 -3
View File
@@ -11,12 +11,19 @@ body:
- label: Read Loop Warning on Readme
- label: Done the troubleshooting from Readme
- label: Checked if such issue already exists
- label: Checked other websites with Cloudflare Turnstile
- label: Checked other websites with Cloudflare Turnstile
- label: I am able to access the webpage from my browser
- type: checkboxes
attributes:
label: "If checked other websites with Cloudflare Turnstile:"
options:
- label: Other websites do work.
- label: Other websites do not work.
- type: input
id: docker-host
attributes:
label: OS
label: OS/Docker Host
placeholder: e.g. Docker, WSL2, Ubuntu, Windows
- type: input
@@ -34,7 +41,7 @@ body:
- type: input
id: website
attributes:
label: Website
label: Example website/URL that does not work
placeholder: e.g. https://nowsecure.nl
- type: textarea
+9 -5
View File
@@ -9,7 +9,7 @@ on:
schedule:
- cron: "25 0 * * *"
push:
branches: ["main"]
branches: ["*"]
# Publish semver tags as releases.
tags: ["v*.*.*"]
pull_request:
@@ -22,6 +22,10 @@ env:
# github.repository as <account>/<repo>
IMAGE_NAME: ${{ github.repository }}
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
runs-on: ubuntu-latest
@@ -32,7 +36,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
@@ -50,6 +54,7 @@ jobs:
build:
needs: test
if: github.event_name != 'pull_request'
runs-on: ubuntu-latest
permissions:
contents: read
@@ -62,7 +67,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Prepare variables
id: vars
@@ -115,7 +120,6 @@ jobs:
merge-and-push:
needs: build
runs-on: ubuntu-latest
if: github.event_name != 'pull_request'
permissions:
contents: read
packages: write
@@ -123,7 +127,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v4
uses: actions/checkout@v5
# Install the cosign tool
- name: Install cosign
+4 -1
View File
@@ -168,4 +168,7 @@ core
screenshots/
# Downloaded files
downloaded_files/
downloaded_files/
# Browser Data
browser_data/
+2
View File
@@ -1,10 +1,12 @@
{
"version": "0.2.0",
"configurations": [
{
"console": "integratedTerminal",
"env": {
"LOG_LEVEL": "DEBUG"
},
"purpose": ["debug-test", "debug-in-terminal"],
"justMyCode": false,
"name": "Python Debugger: Main",
"program": "main.py",
+17 -22
View File
@@ -1,23 +1,18 @@
{
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff"
},
"python.analysis.autoImportCompletions": true,
"python.analysis.packageIndexDepths": [
{
"depth": 5,
"includeAllSymbols": true,
"name": ""
}
],
"python.analysis.typeCheckingMode": "standard",
"python.terminal.activateEnvironment": true,
"python.testing.pytestArgs": [
"tests",
"-n",
"auto",
"--retries=3",
],
"python.testing.pytestEnabled": true,
"python.testing.unittestEnabled": false
}
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff"
},
"python.analysis.autoImportCompletions": true,
"python.analysis.packageIndexDepths": [
{
"depth": 5,
"includeAllSymbols": true,
"name": ""
}
],
"python.terminal.activateEnvironment": true,
"python.testing.pytestArgs": ["tests", "-n", "auto", "--retries=3"],
"python.testing.pytestEnabled": true,
"python.testing.unittestEnabled": false,
"cSpell.words": ["camoufox", "domcontentloaded", "networkidle"]
}
+7 -12
View File
@@ -1,4 +1,4 @@
FROM debian:bookworm-slim AS base
FROM debian:stable-slim AS base
ENV HOME=/root
ARG GITHUB_BUILD=false \
@@ -10,21 +10,19 @@ ENV GITHUB_BUILD=${GITHUB_BUILD}\
PYTHONUNBUFFERED=1 \
# prevents python creating .pyc files
PYTHONDONTWRITEBYTECODE=1 \
DISPLAY=:0\
UV_LINK_MODE=copy \
PATH="${HOME}/.local/bin:$PATH"
WORKDIR /app
RUN apt-get update && \
apt-get install -y --no-install-recommends --no-install-suggests xauth xvfb scrot curl chromium chromium-driver ca-certificates tini
RUN apt update && apt -y upgrade && apt install -y curl
ADD https://astral.sh/uv/install.sh install.sh
RUN sh install.sh && uv --version
RUN uvx playwright install-deps firefox && uvx camoufox fetch
FROM base AS devcontainer
RUN apt install -y git && apt upgrade -y
ENV UV_LINK_MODE=copy
RUN apt install -y git
ENTRYPOINT [ "sleep", "infinity" ]
@@ -32,16 +30,13 @@ FROM base AS app
COPY pyproject.toml uv.lock ./
RUN --mount=type=cache,target=${HOME}/.cache/uv uv sync
# SeleniumBase does not come with an arm64 chromedriver binary
RUN cd .venv/lib/*/site-packages/seleniumbase/drivers && rm -f uc_driver && ln -s /usr/bin/chromedriver uc_driver
COPY . .
FROM app AS test
RUN --mount=type=cache,target=${HOME}/.cache/uv uv sync --group test
RUN ./test.sh
RUN uv run pytest --retries 3 -n auto
FROM app
EXPOSE 8191
HEALTHCHECK --interval=15m --timeout=30s --start-period=5s --retries=3 CMD [ "curl", "http://localhost:8191/health" ]
ENTRYPOINT ["/usr/bin/tini", "--", "uv", "run", "main.py"]
ENTRYPOINT ["uv", "run", "main.py"]
+9 -8
View File
@@ -1,6 +1,6 @@
# Byparr
An alternative to [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) as a drop-in replacement, built with [seleniumbase](https://seleniumbase.io/) and [FastAPI](https://fastapi.tiangolo.com).
Built with [camoufox](https://camoufox.com/) and [FastAPI](https://fastapi.tiangolo.com), this project aims to mimic [FlareSolverr's](https://github.com/FlareSolverr/FlareSolverr) API and functionality of providing you with http cookies and headers for websites protected with anti-bot protections.
> [!IMPORTANT]
> This software does not **guarantee** (only greatly increases the chance) that any challenge will be bypassed. While this tool passes the initial browser check, Cloudflare and other captcha providers likely require valid network traffic originating from the user’s public IP address to mark a connection as legitimate. If any website does not pass the challenge, please run troubleshooting steps and check if other websites work before you create an GitHub issue.
@@ -33,15 +33,16 @@ An alternative to [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) a
## Options
| Environment Variable | Default | Description |
| -------------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `USE_HEADLESS` | `SeleniumBase default` | Use headless chromium. |
| `PROXY` | None | Proxy to use in format: `protocol://username:password@host:port`. [SOCKS5 with authentication is not supported by Chrome](https://stackoverflow.com/questions/75602916/connection-to-private-proxy-socks5-with-chrome-webrequest-onauthrequired-and), see `compose.yaml` file for a workaround |
| Environment Variable | Default | Description |
| -------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `HOST` | `0.0.0.0` | Host address to bind the server to. Use `0.0.0.0` to bind to all IPv4 interfaces, `::` for all IPv6 interfaces, or `127.0.0.1`/`localhost` for local access only. |
| `PROXY_SERVER` | None | Proxy to use in format: `protocol://host:port`. |
| `PROXY_USERNAME` | None | |
| `PROXY_PASSWORD` | None | |
## Proxy Recommendation
Recently I've partnered with a *new in town* proxy service - ProxyBase - to offer affordable proxy services that seems to work seamlessly with Byparr! Using my affiliate code `byparr` (case sensitive!) when signing up will not only get you access to their cost-effective (**$0.69/GB with occasional promotions**) proxy network but will also help support the continued development of this project. ProxyBase's proxies can significantly improve your success rate when bypassing anti-bot challenges. [Check out ProxyBase](https://client.proxybase.org/signup?ref=byparr
) and enhance your Byparr experience!
Recently I've partnered with a _new in town_ proxy service - ProxyBase - to offer affordable proxy services that seems to work seamlessly with Byparr! Using my affiliate code `byparr` (case sensitive!) when signing up will not only get you access to their cost-effective (**$0.69/GB with occasional promotions** _at the time of writing_) proxy network but will also help support the continued development of this project. ProxyBase's proxies can significantly improve your success rate when bypassing anti-bot challenges. [Check out ProxyBase](https://client.proxybase.org/signup?ref=byparr) and enhance your Byparr experience!
## Tags
@@ -57,7 +58,7 @@ See `compose.yaml`
### Docker
```bash
docker run --shm-size=2gb -p 8191:8191 ghcr.io/thephaseless/byparr:latest
docker run -p 8191:8191 ghcr.io/thephaseless/byparr:latest
```
### Local
+1 -17
View File
@@ -2,25 +2,9 @@ services:
byparr:
image: ghcr.io/thephaseless/byparr:latest
restart: unless-stopped
shm_size: 2gb
build:
context: .
dockerfile: Dockerfile
# # Uncomment below to use pproxy
# environment:
# - PROXY=http://pproxy:8080
volumes:
- ./screenshots:/app/screenshots # (optional) For screenshots when exception occurs
# # Uncomment below to use byparr outside of internal network
# Uncomment below to use byparr outside of internal network
# ports:
# - "8191:8191"
# # Uncomment the following lines to enable pproxy for socks5 proxy
# pproxy:
# tty: true # Required for pproxy to work
# container_name: pproxy
# restart: unless-stopped
# image: mosajjal/pproxy:latest
# command:
# - -vv
# - -l http://:8080
# - -r socks5://host:port#username:password # Fill in your proxy credentials and address
Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

+22 -3
View File
@@ -1,17 +1,21 @@
from __future__ import annotations
import asyncio
import logging
import os
import sys
import uvicorn
from fastapi import FastAPI
from fastapi.middleware.gzip import GZipMiddleware
from src.consts import LOG_LEVEL, VERSION
from src.endpoints import router
from src.endpoints import health_check, router
from src.middlewares import LogRequest
from src.utils import logger
from src.utils import get_camoufox, logger
logger.info("Using version %s", VERSION)
logger.info("Log level set to %s", logging.getLevelName(LOG_LEVEL))
app = FastAPI(debug=LOG_LEVEL == logging.DEBUG, log_level=LOG_LEVEL)
app.add_middleware(GZipMiddleware)
@@ -20,5 +24,20 @@ app.add_middleware(LogRequest)
app.include_router(router=router)
async def init():
"""Initialize the application."""
async for browser in get_camoufox():
await health_check(browser)
if __name__ == "__main__":
uvicorn.run(app, host="0.0.0.0", port=8191, log_level=LOG_LEVEL) # noqa: S104
# Check for --init flag to run the app in development mode
if "--init" in sys.argv:
logger.info("Running initialization script...")
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
loop.run_until_complete(init())
logger.info("Initialization complete.")
else:
host = os.getenv("HOST", "0.0.0.0") # noqa: S104
uvicorn.run(app, host=host, port=8191)
+15 -15
View File
@@ -8,22 +8,24 @@ version = "0.1.0"
description = "API for getting cookies for Cloudflare challenges"
readme = "README.md"
dependencies = [
"fastapi[standard]==0.115.12",
"pyautogui==0.9.54",
"pydantic==2.11.5",
"seleniumbase==4.39.2",
"uvicorn==0.34.3",
"camoufox[geoip]==0.4.*",
"fastapi[standard]==0.116.*",
"playwright-captcha==0.1.*",
"pydantic==2.11.*",
]
urls = { repository = "https://github.com/ThePhaseless/Byparr" }
[dependency-groups]
test = [
"httpx==0.28.1",
"pytest-asyncio==1.0.0",
"pytest-progress==1.3.0",
"pytest-retry==1.7.0",
"httpx==0.28.*",
"pytest==8.4.*",
"pytest-asyncio==1.1.*",
"pytest-progress==1.3.*",
"pytest-retry==1.7.*",
"pytest-xdist==3.8.*",
"setuptools>=80.9.0",
]
dev = ["deptry==0.23.0", "ruff==0.11.13"]
dev = ["deptry==0.23.*", "ruff==0.13.*"]
[tool.deptry.per_rule_ignores]
DEP002 = ["pyautogui"]
@@ -57,8 +59,6 @@ ignore = [
select = ["ALL"]
extend-safe-fixes = ["D415"]
[tool.pytest]
log_cli = "True"
[tool.pytest.ini_options]
asyncio_default_fixture_loop_scope = "function"
[tool.pyright]
reportMissingTypeStubs = false
typeCheckingMode = "strict"
+1
View File
@@ -1,6 +1,7 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["config:recommended"],
"forkProcessing": "enabled",
"packageRules": [
{
"automerge": true,
+21 -35
View File
@@ -1,43 +1,29 @@
import logging
import os
import sys
from pathlib import Path
def get_version_from_env():
"""
Retrieve the version from the environment variable 'VERSION'.
This function checks the 'VERSION' environment variable for a value
that starts with 'v' and returns the version without the prefix.
Returns:
str | None: The version string without the 'v' prefix, or None if
the 'VERSION' environment variable is not set or does not start
with 'v'.
"""
version_env = os.getenv("VERSION")
if not version_env:
return None
return version_env.removeprefix("v")
LOG_LEVEL = os.getenv("LOG_LEVEL") or "INFO"
LOG_LEVEL = logging.getLevelNamesMapping()[LOG_LEVEL.upper()]
VERSION = get_version_from_env() or "unknown"
USE_XVFB = os.getenv("USE_XVFB") in ["true", "1"] if os.getenv("USE_XVFB") else None
USE_HEADLESS = (
os.getenv("USE_HEADLESS") in ["true", "1"] if os.getenv("USE_HEADLESS") else None
from playwright_captcha import CaptchaType
from playwright_captcha.utils.camoufox_add_init_script.add_init_script import (
get_addon_path,
)
PROXY = os.getenv("PROXY")
LOG_LEVEL = logging.getLevelNamesMapping()[os.getenv("LOG_LEVEL", "INFO").upper()]
VERSION = os.getenv("VERSION", "unknown").removeprefix("v")
ADDON_PATH = str(Path(get_addon_path()).absolute())
MAX_ATTEMPTS = sys.maxsize
PROXY_SERVER = os.getenv("PROXY_SERVER")
PROXY_USERNAME = os.getenv("PROXY_USERNAME")
PROXY_PASSWORD = os.getenv("PROXY_PASSWORD")
CHALLENGE_TITLES_MAP: dict[CaptchaType, list[str]] = {
# Cloudflare
CaptchaType.CLOUDFLARE_INTERSTITIAL: ["Just a moment..."],
}
CHALLENGE_TITLES = [
# Cloudflare
"Just a moment...",
# DDoS-GUARD
"DDoS-Guard",
title for titles in CHALLENGE_TITLES_MAP.values() for title in titles
]
+52 -32
View File
@@ -1,10 +1,12 @@
import time
import warnings
from asyncio import wait_for
from http import HTTPStatus
from typing import Annotated
from fastapi import APIRouter, Depends, HTTPException
from fastapi.responses import RedirectResponse
from sbase import BaseCase
from playwright_captcha import CaptchaType
from src.consts import CHALLENGE_TITLES
from src.models import (
@@ -13,11 +15,14 @@ from src.models import (
LinkResponse,
Solution,
)
from src.utils import get_sb, logger, save_screenshot
from src.utils import CamoufoxDepClass, TimeoutTimer, get_camoufox, logger
warnings.filterwarnings("ignore", category=SyntaxWarning)
router = APIRouter()
SeleniumDep = Annotated[BaseCase, Depends(get_sb)]
CamoufoxDep = Annotated[CamoufoxDepClass, Depends(get_camoufox)]
@router.get("/", include_in_schema=False)
@@ -28,9 +33,9 @@ def read_root():
@router.get("/health")
def health_check(sb: SeleniumDep):
async def health_check(sb: CamoufoxDep):
"""Health check endpoint."""
health_check_request = read_item(
health_check_request = await read_item(
LinkRequest.model_construct(url="https://google.com"),
sb,
)
@@ -41,46 +46,61 @@ def health_check(sb: SeleniumDep):
detail="Health check failed",
)
return HealthcheckResponse(user_agent=sb.get_user_agent())
return HealthcheckResponse(user_agent=health_check_request.solution.user_agent)
@router.post("/v1")
def read_item(request: LinkRequest, sb: SeleniumDep) -> LinkResponse:
async def read_item(request: LinkRequest, dep: CamoufoxDep) -> LinkResponse:
"""Handle POST requests."""
start_time = int(time.time() * 1000)
timer = TimeoutTimer(duration=request.max_timeout)
request.url = request.url.replace('"', "").strip()
sb.uc_open_with_reconnect(request.url)
logger.debug(f"Got webpage: {request.url}")
source_bs = sb.get_beautiful_soup()
title_tag = source_bs.title
if title_tag and title_tag.string in CHALLENGE_TITLES:
logger.debug("Challenge detected")
sb.uc_gui_click_captcha()
logger.info("Clicked captcha")
try:
page_request = await dep.page.goto(
request.url, timeout=timer.remaining() * 1000
)
status = page_request.status if page_request else HTTPStatus.OK
await dep.page.wait_for_load_state(
state="domcontentloaded", timeout=timer.remaining() * 1000
)
await dep.page.wait_for_load_state(
"networkidle", timeout=timer.remaining() * 1000
)
if sb.get_title() in CHALLENGE_TITLES:
save_screenshot(sb)
raise HTTPException(status_code=500, detail="Could not bypass challenge")
if await dep.page.title() in CHALLENGE_TITLES:
logger.info("Challenge detected, attempting to solve...")
# Solve the captcha
await wait_for(
dep.solver.solve_captcha( # pyright: ignore[reportUnknownMemberType,reportUnknownArgumentType]
captcha_container=dep.page,
captcha_type=CaptchaType.CLOUDFLARE_INTERSTITIAL,
wait_checkbox_attempts=1,
wait_checkbox_delay=0.5,
),
timeout=timer.remaining(),
)
status = HTTPStatus.OK
logger.debug("Challenge solved successfully.")
except TimeoutError as e:
logger.error("Timed out while solving the challenge")
raise HTTPException(
status_code=408,
detail="Timed out while solving the challenge",
) from e
cookies = sb.get_cookies()
for cookie in cookies:
name = cookie["name"]
value = cookie["value"]
cookie["size"] = len(f"{name}={value}".encode())
cookie["session"] = False
if "expiry" in cookie:
cookie["expires"] = cookie["expiry"]
cookies = await dep.context.cookies()
return LinkResponse(
message="Success",
solution=Solution(
user_agent=sb.get_user_agent(),
url=sb.get_current_url(),
status=200,
user_agent=await dep.page.evaluate("navigator.userAgent"),
url=dep.page.url,
status=status,
cookies=cookies,
headers={},
response=str(sb.get_beautiful_soup()),
headers=page_request.headers if page_request else {},
response=await dep.page.content(),
),
start_timestamp=start_time,
)
+4 -3
View File
@@ -1,14 +1,15 @@
import time
from http import HTTPStatus
from starlette.middleware.base import BaseHTTPMiddleware
from fastapi import Request
from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
from src.models import LinkRequest
from src.utils import logger
class LogRequest(BaseHTTPMiddleware):
async def dispatch(self, request, call_next):
async def dispatch(self, request: Request, call_next: RequestResponseEndpoint):
"""Log requests."""
if request.url.path != "/v1" or request.method != "POST":
return await call_next(request)
@@ -24,6 +25,6 @@ class LogRequest(BaseHTTPMiddleware):
if response.status_code == HTTPStatus.OK:
logger.info(f"Done {request_body.url} in {process_time:.2f}s")
else:
logger.info(f"Failed {request_body.url} in {process_time:.2f}s")
logger.warning(f"Failed {request_body.url} in {process_time:.2f}s")
return response
+7 -3
View File
@@ -4,6 +4,7 @@ import time
from http.client import INTERNAL_SERVER_ERROR
from typing import Any
from playwright.sync_api import Cookie
from pydantic import BaseModel, Field
from pydantic.alias_generators import to_camel
@@ -16,12 +17,15 @@ class LinkRequest(BaseModel):
description="Type of request, currently only supports GET requests. This string is purely for compatibility with FlareSolverr.",
)
url: str = Field(pattern=r"^https?://", default="https://")
max_timeout: int = Field(default=60)
max_timeout: int = Field(
default=60,
description="Maximum timeout in seconds for resolving the anti-bot challenge.",
)
class HealthcheckResponse(BaseModel):
model_config = {"alias_generator": to_camel, "populate_by_name": True}
msg: str = "Byparr is ready!"
msg: str = "Byparr is working!"
version: str = consts.VERSION
user_agent: str
@@ -30,7 +34,7 @@ class Solution(BaseModel):
model_config = {"alias_generator": to_camel, "populate_by_name": True}
url: str
status: int
cookies: list = []
cookies: list[Cookie] = []
user_agent: str = ""
headers: dict[str, Any] = {}
response: str = ""
+73 -29
View File
@@ -1,11 +1,32 @@
import logging
from time import gmtime, strftime
import time
from collections.abc import AsyncGenerator
from typing import NamedTuple, cast
from fastapi import Header, HTTPException
from httpx import codes
from sbase import SB, BaseCase
from camoufox import AsyncCamoufox
from playwright.async_api import Browser, BrowserContext, Page
from playwright_captcha import (
ClickSolver,
FrameworkType,
)
from pydantic import BaseModel, Field
from src.consts import LOG_LEVEL, PROXY, USE_HEADLESS
from src.consts import (
ADDON_PATH,
LOG_LEVEL,
MAX_ATTEMPTS,
PROXY_PASSWORD,
PROXY_SERVER,
PROXY_USERNAME,
)
solver_logger = logging.getLogger("playwright_captcha")
solver_logger.handlers.clear()
if LOG_LEVEL == logging.DEBUG:
solver_logger.addHandler(logging.StreamHandler())
solver_logger.setLevel(LOG_LEVEL)
else:
solver_logger.handlers.append(logging.NullHandler())
logger = logging.getLogger("uvicorn.error")
logger.setLevel(LOG_LEVEL)
@@ -13,30 +34,53 @@ if len(logger.handlers) == 0:
logger.addHandler(logging.StreamHandler())
def get_sb(
proxy: str | None = Header(
default=PROXY,
examples=["protocol://username:password@host:port"],
description="Override default proxy address",
),
):
"""Get SeleniumBase instance."""
if proxy and proxy.startswith("socks5://") and "@" in proxy:
raise HTTPException(
status_code=codes.BAD_REQUEST,
detail="SOCKS5 proxy with authentication is not supported. Check README for more info.",
)
class TimeoutTimer(BaseModel):
duration: int # in seconds
start_time: float = Field(default_factory=time.perf_counter)
with SB(
uc=True,
headless=USE_HEADLESS,
locale_code="en",
ad_block=True,
proxy=proxy,
) as sb:
yield sb
def remaining(self) -> float:
"""Get remaining time in seconds."""
return max(0, self.duration - (time.perf_counter() - self.start_time))
def save_screenshot(sb: BaseCase):
"""Save screenshot on HTTPException."""
sb.save_screenshot(f"screenshots/{strftime('%Y-%m-%d %H:%M:%S', gmtime())}.png")
class CamoufoxDepClass(NamedTuple):
page: Page
solver: ClickSolver
context: BrowserContext
async def get_camoufox() -> AsyncGenerator[CamoufoxDepClass, None]:
"""Get Camoufox instance."""
proxy_config = (
{
"server": PROXY_SERVER,
"username": PROXY_USERNAME,
"password": PROXY_PASSWORD,
}
if PROXY_SERVER
else None
)
async with AsyncCamoufox(
main_world_eval=True,
addons=[ADDON_PATH],
geoip=True,
proxy=proxy_config,
locale="en-US",
headless=True,
humanize=True,
i_know_what_im_doing=True,
config={"forceScopeAccess": True}, # add this when creating Camoufox instance
disable_coop=True, # add this when creating Camoufox instance
) as browser_raw:
# Cast to Browser since AsyncCamoufox always returns a Browser, not BrowserContext
browser = cast("Browser", browser_raw)
context = await browser.new_context()
page = await context.new_page()
async with ClickSolver(
framework=FrameworkType.CAMOUFOX,
page=page,
max_attempts=MAX_ATTEMPTS,
attempt_delay=1,
) as solver:
yield CamoufoxDepClass(page, solver, context)
+13 -11
View File
@@ -1,4 +1,5 @@
from http import HTTPStatus
from json import JSONDecodeError
import httpx
import pytest
@@ -11,11 +12,11 @@ client = TestClient(app)
test_websites = [
"https://ext.to/",
"https://www.ygg.re/",
# "https://www.ygg.re/",
"https://extratorrent.st/",
"https://idope.se/",
"https://speed.cd/login",
'https://www.yggtorrent.top/engine/search?do=search&order=desc&sort=publish_date&name="UNESCAPED"+"DOUBLEQUOTES"&category=2145'
'https://www.yggtorrent.top/engine/search?do=search&order=desc&sort=publish_date&name="UNESCAPED"+"DOUBLEQUOTES"&category=2145',
"https://1337x.to/home/",
]
@@ -30,19 +31,20 @@ def test_bypass(website: str):
website,
)
if (
test_request.status_code != HTTPStatus.OK
test_request.status_code >= HTTPStatus.INTERNAL_SERVER_ERROR
and "Just a moment..." not in test_request.text
):
pytest.skip(f"Skipping {website} due to {test_request.status_code}")
try:
error_details = test_request.json()
except JSONDecodeError:
error_details = test_request.text
pytest.skip(
f"Skipping {website} - ({test_request.status_code}) {error_details}"
)
response = client.post(
"/v1",
json={
**LinkRequest.model_construct(
url=website, max_timeout=30, cmd="request.get"
).model_dump(),
# "proxy": "203.174.15.83:8080",
},
json=LinkRequest.model_construct(url=website, cmd="request.get").model_dump(),
)
assert response.status_code == HTTPStatus.OK
Generated
+905 -619
View File
File diff suppressed because it is too large Load Diff