Metadata-Version: 2.1
Name: botright
Version: 0.3.post1
Summary: Botright, the next level automation studio for Python. Based on Playwright.
Home-page: https://github.com/Vinyzu/Botright
Author: Vinyzu
License: GNU General Public License v3.0
Project-URL: Documentation, https://github.com/Vinyzu/Botright/blob/main/docs/index.rst
Project-URL: Source, https://github.com/Vinyzu/Botright
Keywords: botright,playwright,recaptcha_challenger,recaptcha-solver,hcaptcha_challenger,hcaptcha-solver,geetest_challenger,geetest-solver
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: async-class
Requires-Dist: httpx >=0.24.1
Requires-Dist: playwright ==1.37.0
Requires-Dist: playwright-stealth ==1.0.6
Requires-Dist: numpy ==1.25.2
Requires-Dist: scipy ==1.11.2
Requires-Dist: Pillow ==10.0.1
Requires-Dist: hcaptcha-challenger >=0.7.10.post2
Requires-Dist: yolov5 ==7.0.12
Requires-Dist: sentence-transformers
Requires-Dist: easyocr ==1.7.1
Requires-Dist: Faker ==19.6.1
Requires-Dist: scikit-image ==0.21.0
Requires-Dist: opencv-python ~=4.8.0.76
Requires-Dist: pytest ==7.4.2
Requires-Dist: imageio ==2.31.3
Requires-Dist: setuptools ==68.2.2

# Botright v0.3

## Install it from PyPI

```bash
pip install botright
playwright install
```

---

## Usage

### Botright is currently only available in async mode.
### It is fully plugable with your existing playwright code. You only have to change your browser initialization!

```py
import asyncio

import botright


async def main():
    botright_client = await botright.Botright(headless=False)
    browser = await botright_client.new_browser()
    page = await browser.new_page()

    # Continue by using the Page
    await page.goto("https://google.com")

    await botright_client.close()

if __name__ == "__main__":
    asyncio.run(main())
```

Read the [Documentation](https://botright.readthedocs.io/en/latest)

---

## Browser Stealth

Botright uses a vast amount of techniques to hide its functionality as a bot from websites.
To enhance stealth, since Version 0.3, it uses a real Chromium-based browser from the local machine to start up a botted browser.
Furthermore, it scrapes information about the browser and from the internet, to build up a fake browser fingerprint and to deceive website into thinking it is legit.

---

## Captcha Solving

Botright is able to solve a wide viarity of Captchas.
For Documentation of these functions visit [BotrightDocumentation](botright.md).

It uses Computer Vision/Artificial Intelligence and other Methods to solve these Captchas.

You dont need to pay for any Captcha Solving APIs and you can solve Captchas with just one simple function call.

Here all Captchas supported as of now:

| Captcha Type | Supported |            Solved By            | Success Rate |
|:--------------:|:--------------:|:-------------------------------:|--------------|
| `hCaptcha` | ✔️ |       hcaptcha-challenger       | up to 90%    |
| `reCaptcha` | ✔️ |      recaptcha-challenger       | 50%-80%      |
| `geeTestv3` |
| v3 Intelligent Mode | ✔️ |     botrights stealthiness      | 100%         |
| v3 Slider Captcha | ✔️ |        cv2.matchTemplate        | 100%         |
| v3 Nine Captcha | ✔️ |         CLIP Detection          | 50%          |
| v3 Icon Captcha | ✔️ | cv2.matchTemplate / SSIM / CLIP | 70%          |
| v3 Space Captcha | ❌ |          Not solvable           | 0%           |
| `geeTestv4` |
| v4 Intelligent Mode | ✔️ |     botrights stealthiness      | 100%         |
| v4 Slider Captcha | ✔️ |        cv2.matchTemplate        | 100%         |
| v4 GoBang Captcha | ✔️ |        Math Calculations        | 100%         |
| v4 Icon Captcha | ✔️ | cv2.matchTemplate / SSIM / CLIP | 60%          |
| v4 IconCrush Captcha | ✔️ |        Math Calculations        | 100%         |

## Development

Read the [CONTRIBUTING.md](https://github.com/Vinyzu/Botright/blob/main/CONTRIBUTING.md) file.

---

## Copyright and License
© [Vinyzu](https://github.com/Vinyzu/)

[GNU GPL](https://choosealicense.com/licenses/gpl-3.0/)

(Commercial Usage is allowed, but source, license and copyright has to made available. Botright does not provide and Liability or Warranty)

---

## Thanks to

[QIN2DIM](https://github.com/QIN2DIM/) (For his great AI work)

[MaxAndolini](https://github.com/MaxAndolini) (For shared knowledge of hCaptcha bypassing)

[CreativeProxies](https://creativeproxies.com) (For sponsoring me with Proxies)

---

![Version](https://img.shields.io/badge/Botright-v0.3-blue)
![License](https://img.shields.io/badge/License-GNU%20GPL-green)
![Python](https://img.shields.io/badge/Python-v3.x-lightgrey)

[![my-discord](https://img.shields.io/badge/My_Discord-000?style=for-the-badge&logo=google-chat&logoColor=blue)](https://discordapp.com/users/935224495126487150)
[![buy-me-a-coffee](https://img.shields.io/badge/Buy_Me_A_Coffee-000?style=for-the-badge&logo=ko-fi&logoColor=brown)](https://ko-fi.com/vinyzu)
