<div align="center">
# Camoufox Python Interface
#### Lightweight wrapper around the Playwright API to help launch Camoufox.
</div>
> [!NOTE]
> All the the latest documentation is avaliable [here](https://camoufox.com/python).
---
## What is this?
This Python library wraps around Playwright's API to help automatically generate & inject unique device characteristics (OS, CPU info, navigator, fonts, headers, screen dimensions, viewport size, WebGL, addons, etc.) into Camoufox.
It uses [BrowserForge](https://github.com/daijro/browserforge) under the hood to generate fingerprints that mimic the statistical distribution of device characteristics in real-world traffic.
In addition, it will also calculate your target geolocation, timezone, and locale to avoid proxy protection ([see demo](https://i.imgur.com/UhSHfaV.png)).
---
## Installation
First, install the `camoufox` package:
```bash
pip install -U camoufox[geoip]
```
The `geoip` parameter is optional, but heavily recommended if you are using proxies. It will download an extra dataset to determine the user's longitude, latitude, timezone, country, & locale.
Next, download the Camoufox browser:
**Windows**
```bash
camoufox fetch
```
**MacOS & Linux**
```bash
python3 -m camoufox fetch
```
To uninstall, run `camoufox remove`.
<details>
<summary>CLI options</summary>
```
Usage: python -m camoufox [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
fetch Fetch the latest version of Camoufox
path Display the path to the Camoufox executable
remove Remove all downloaded files
server Launch a Playwright server
test Open the Playwright inspector
version Display the current version
```
</details>
<hr width=50>
## Usage
All of the latest documentation is avaliable at [camoufox.com/python](https://camoufox.com/python).
Raw data
{
"_id": null,
"home_page": "https://camoufox.com/python",
"name": "camoufox",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "client, fingerprint, browser, scraping, injector, firefox, playwright",
"author": "daijro",
"author_email": "daijro.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e2/46/3247cde66dd69f265e58cfb2a459d06214d38fab9c61a0fdc11ad01437f1/camoufox-0.3.9.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# Camoufox Python Interface\n\n#### Lightweight wrapper around the Playwright API to help launch Camoufox.\n\n</div>\n\n> [!NOTE]\n> All the the latest documentation is avaliable [here](https://camoufox.com/python).\n\n---\n\n## What is this?\n\nThis Python library wraps around Playwright's API to help automatically generate & inject unique device characteristics (OS, CPU info, navigator, fonts, headers, screen dimensions, viewport size, WebGL, addons, etc.) into Camoufox.\n\nIt uses [BrowserForge](https://github.com/daijro/browserforge) under the hood to generate fingerprints that mimic the statistical distribution of device characteristics in real-world traffic.\n\nIn addition, it will also calculate your target geolocation, timezone, and locale to avoid proxy protection ([see demo](https://i.imgur.com/UhSHfaV.png)).\n\n---\n\n## Installation\n\nFirst, install the `camoufox` package:\n\n```bash\npip install -U camoufox[geoip]\n```\n\nThe `geoip` parameter is optional, but heavily recommended if you are using proxies. It will download an extra dataset to determine the user's longitude, latitude, timezone, country, & locale.\n\nNext, download the Camoufox browser:\n\n**Windows**\n\n```bash\ncamoufox fetch\n```\n\n**MacOS & Linux**\n\n```bash\npython3 -m camoufox fetch\n```\n\nTo uninstall, run `camoufox remove`.\n\n<details>\n<summary>CLI options</summary>\n\n```\nUsage: python -m camoufox [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n fetch Fetch the latest version of Camoufox\n path Display the path to the Camoufox executable\n remove Remove all downloaded files\n server Launch a Playwright server\n test Open the Playwright inspector\n version Display the current version\n```\n\n</details>\n\n<hr width=50>\n\n## Usage\n\nAll of the latest documentation is avaliable at [camoufox.com/python](https://camoufox.com/python).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Wrapper around Playwright to help launch Camoufox",
"version": "0.3.9",
"project_urls": {
"Homepage": "https://camoufox.com/python",
"Repository": "https://github.com/daijro/camoufox"
},
"split_keywords": [
"client",
" fingerprint",
" browser",
" scraping",
" injector",
" firefox",
" playwright"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abb54a4d5e7fa7e215f709f0e32293752e76229df460e4566ca1b4203ffb1715",
"md5": "949eb916fd95ac35a1ef12610cbcda49",
"sha256": "8043bb91a786999c127df6c6cb0dd799487bb8e26bfb71ae0b97d466307e39e2"
},
"downloads": -1,
"filename": "camoufox-0.3.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "949eb916fd95ac35a1ef12610cbcda49",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 60789,
"upload_time": "2024-11-12T04:12:19",
"upload_time_iso_8601": "2024-11-12T04:12:19.700465Z",
"url": "https://files.pythonhosted.org/packages/ab/b5/4a4d5e7fa7e215f709f0e32293752e76229df460e4566ca1b4203ffb1715/camoufox-0.3.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e2463247cde66dd69f265e58cfb2a459d06214d38fab9c61a0fdc11ad01437f1",
"md5": "decdb318aabb58475556f194ef34ec09",
"sha256": "ebea6df4be8d85d33655674a38e375ab203b2578f84466ec0e8f1efda5823f8c"
},
"downloads": -1,
"filename": "camoufox-0.3.9.tar.gz",
"has_sig": false,
"md5_digest": "decdb318aabb58475556f194ef34ec09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 55332,
"upload_time": "2024-11-12T04:12:21",
"upload_time_iso_8601": "2024-11-12T04:12:21.444917Z",
"url": "https://files.pythonhosted.org/packages/e2/46/3247cde66dd69f265e58cfb2a459d06214d38fab9c61a0fdc11ad01437f1/camoufox-0.3.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 04:12:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daijro",
"github_project": "camoufox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "camoufox"
}
JSON
