foxyz 1.0.4__tar.gz

foxyz-1.0.4/PKG-INFO

@@ -0,0 +1,348 @@
+Metadata-Version: 2.4
+Name: foxyz
+Version: 1.0.4
+Summary: Wrapper around Playwright to help launch Foxyz
+License: MIT
+Keywords: client,fingerprint,browser,scraping,injector,firefox,playwright
+Author: AntifoxyzDev
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: geoip
+Provides-Extra: gui
+Requires-Dist: PySide6 ; extra == "gui"
+Requires-Dist: browserforge (>=1.2.4,<2.0.0)
+Requires-Dist: geoip2 ; extra == "geoip"
+Requires-Dist: inquirer
+Requires-Dist: language-tags
+Requires-Dist: lxml
+Requires-Dist: numpy
+Requires-Dist: orjson
+Requires-Dist: platformdirs
+Requires-Dist: playwright
+Requires-Dist: pysocks
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: rich
+Requires-Dist: rich-click
+Requires-Dist: screeninfo
+Requires-Dist: typing_extensions
+Requires-Dist: ua_parser
+Project-URL: Repository, https://github.com/foxyzcoding/foxyz
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# Foxyz Python Interface
+
+#### Lightweight wrapper around the Playwright API to help launch Foxyz.
+
+</div>
+
+> [!NOTE]
+> All the the latest documentation is avaliable [here](https://github.com/AntifoxyzDev/foxyz).
+
+---
+
+## 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 Foxyz.
+
+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 `foxyz` package:
+
+```bash
+pip install -U foxyz[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 Foxyz browser:
+
+**Windows**
+
+```bash
+foxyz fetch
+```
+
+**MacOS & Linux**
+
+```bash
+python3 -m foxyz fetch
+```
+
+To uninstall, run `foxyz remove`.
+
+---
+
+# Installing multiple Foxyz versions & from other repos
+
+## UI Manager
+
+Manage installed browsers, active version, IP geolocation databases, and package info. Basically a Qt front end for the Python CLI tool.
+
+More updates on it will be coming soon.
+
+<img width="802" height="552" alt="ui-screenshot" src="https://github.com/user-attachments/assets/6668f8f0-5b08-4c36-bbea-fea4baeccc9c" />
+
+<hr width=50>
+
+To use the gui, install Foxyz with the `[gui]` extra:
+
+```bash
+pip install 'foxyz[gui]'
+```
+
+To launch:
+
+```bash
+foxyz gui
+```
+
+---
+
+## CLI Mananger
+
+#### Demonstration
+
+https://github.com/user-attachments/assets/992b1830-6b21-4024-9165-728854df1473
+
+<details>
+<summary>See help message</summary>
+
+```
+$ python -m foxyz --help
+
+ Usage: python -m foxyz [OPTIONS] COMMAND [ARGS]...
+
+╭─ Options ─────────────────────────────────────────────────────────────────────────────╮
+│ --help  Show this message and exit.                                                   │
+╰───────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ────────────────────────────────────────────────────────────────────────────╮
+│ active    Print the current active version                                            │
+│ fetch     Install the active version, or a specific version                           │
+│ gui       Launch the Foxyz Manager GUI (requires PySide6)                          │
+│ list      List Foxyz versions                                                      │
+│ path      Print the install directory path                                            │
+│ remove    Remove downloaded data. By default, this removes everything.                │
+│           Pass --select to pick a browser version to remove.                          │
+│ server    Launch a Playwright server                                                  │
+│ set       Set the active Foxyz version to use & fetch.                             │
+│           By default, this opens an interactive selector for versions and settings.   │
+│           You can also pass a specifier to activate directly:                         │
+│           Pin version:                                                                │
+│               foxyz set official/stable/134.0.2-beta.20                            │
+│           Automatically find latest in a channel source:                              │
+│               foxyz set official/stable                                            │
+│ sync      Sync available versions from remote repositories                            │
+│ test      Open the Playwright inspector                                               │
+│ version   Display version, package, browser, and storage info                         │
+╰───────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+</details>
+
+### `sync`
+
+Pull a list of release assets from GitHub.
+
+```bash
+> foxyz sync
+Syncing repositories...
+  Official... 24 versions
+  CoryKing... 2 versions
+
+Synced 26 versions from 2 repos.
+```
+
+<hr width=50>
+
+### `set`
+
+Choose a version channel or pin a specific version. Can also be called with a specifier to activate directly.
+
+Interactive selector:
+
+```bash
+> foxyz set
+```
+
+You can also pass a specifier to pin a specific version or choose a channel to follow directly. This will pull the latest stable version from the official repo on `foxyz fetch`.
+
+```bash
+> foxyz set official/stable  # Default setting
+```
+
+Follow latest prerelease version from the official repo, if applicable:
+
+```bash
+> foxyz set official/prerelease
+```
+
+Pin a specific version:
+
+```bash
+> foxyz set official/stable/134.0.2-beta.20
+```
+
+<hr width=50>
+
+### `active`
+
+Prints the current active version string:
+
+```bash
+> foxyz active  # Default channel is active
+official/stable
+```
+
+```bash
+> foxyz set coryking/stable/142.0.1-fork.26
+Pinned: coryking/stable/142.0.1-fork.26
+Run 'foxyz fetch' to install.
+
+> foxyz active  # A specific version is pinned
+coryking/stable/142.0.1-fork.26 (not installed)
+```
+
+<hr width=50>
+
+### `fetch`
+
+Install the latest version from the active channel. By default, this is official/stable. This will also automatically sync repository assets.
+
+```bash
+> foxyz fetch  # Install the latest in the channel
+```
+
+To download the latest from a different channel, or pin a version:
+
+```bash
+> foxyz set coryking/stable
+> foxyz fetch  # Will download the latest release from CoryKing's repo for now on
+```
+
+Or pass in the identifier to download directly without activating it:
+
+```bash
+> foxyz fetch official/stable/135.0-beta.25   # Install a specific version
+```
+
+<hr width=50>
+
+### `list`
+
+List installed or all available Foxyz versions as a tree.
+
+```bash
+> foxyz list          # show installed versions
+> foxyz list all      # show all available versions from synced repos
+> foxyz list --path   # show full install paths
+```
+
+<hr width=50>
+
+### `remove`
+
+By default, removes the entire foxyz data directory.
+
+```bash
+> foxyz remove
+> foxyz remove -y  # skip confirmation prompt
+```
+
+Remove a specific version:
+
+```bash
+> foxyz remove official/stable/134.0.2-beta.20
+```
+
+Interactively select a version to remove:
+
+```bash
+> foxyz remove --select
+```
+
+<hr width=50>
+
+### `version`
+
+Display the Python package version, active browser version, channel, and update status.
+
+```bash
+> foxyz version
+Python Packages
+  Foxyz                    v0.5.0
+  Browserforge                v1.2.4
+  Apify Fingerprints          v0.10.0
+  Playwright                  v1.57.1.dev0+g732639b35.d20251217
+Browser
+  Active                      official/stable/135.0.1-beta.24
+  Current browser             v135.0.1-beta.24
+  Installed                   Yes
+  Latest in official/stable?  Yes
+  Last Sync                   2026-03-07 00:23
+GeoIP
+  Database                    MaxMind GeoLite2
+  Updated                     2026-03-07 00:24
+Storage
+  Install path                /home/name/.cache/foxyz
+  Browser(s) directory size   1.2 GB
+  GeoIP database size         40.7 MB
+  Config file                 /home/name/.cache/foxyz/config.json
+  Repo cache                  /home/name/.cache/foxyz/repo_cache.json
+```
+
+<hr width=50>
+
+### `path`
+
+Print the install directory path.
+
+```bash
+> foxyz path
+/home/name/.cache/foxyz
+```
+
+<hr width=50>
+
+### `test`
+
+Open Foxyz with the Playwright inspector for debugging.
+
+```bash
+> foxyz test
+> foxyz test https://example.com
+```
+
+<hr width=50>
+
+### `server`
+
+Launch a remote Playwright server.
+
+```bash
+> foxyz server
+```
+
+---
+
+## Usage
+
+All of the latest stable documentation is avaliable at [foxyz.com/python](https://github.com/AntifoxyzDev/foxyz).
+

foxyz-1.0.4/README.md

@@ -0,0 +1,306 @@
+<div align="center">
+
+# Foxyz Python Interface
+
+#### Lightweight wrapper around the Playwright API to help launch Foxyz.
+
+</div>
+
+> [!NOTE]
+> All the the latest documentation is avaliable [here](https://github.com/AntifoxyzDev/foxyz).
+
+---
+
+## 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 Foxyz.
+
+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 `foxyz` package:
+
+```bash
+pip install -U foxyz[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 Foxyz browser:
+
+**Windows**
+
+```bash
+foxyz fetch
+```
+
+**MacOS & Linux**
+
+```bash
+python3 -m foxyz fetch
+```
+
+To uninstall, run `foxyz remove`.
+
+---
+
+# Installing multiple Foxyz versions & from other repos
+
+## UI Manager
+
+Manage installed browsers, active version, IP geolocation databases, and package info. Basically a Qt front end for the Python CLI tool.
+
+More updates on it will be coming soon.
+
+<img width="802" height="552" alt="ui-screenshot" src="https://github.com/user-attachments/assets/6668f8f0-5b08-4c36-bbea-fea4baeccc9c" />
+
+<hr width=50>
+
+To use the gui, install Foxyz with the `[gui]` extra:
+
+```bash
+pip install 'foxyz[gui]'
+```
+
+To launch:
+
+```bash
+foxyz gui
+```
+
+---
+
+## CLI Mananger
+
+#### Demonstration
+
+https://github.com/user-attachments/assets/992b1830-6b21-4024-9165-728854df1473
+
+<details>
+<summary>See help message</summary>
+
+```
+$ python -m foxyz --help
+
+ Usage: python -m foxyz [OPTIONS] COMMAND [ARGS]...
+
+╭─ Options ─────────────────────────────────────────────────────────────────────────────╮
+│ --help  Show this message and exit.                                                   │
+╰───────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ────────────────────────────────────────────────────────────────────────────╮
+│ active    Print the current active version                                            │
+│ fetch     Install the active version, or a specific version                           │
+│ gui       Launch the Foxyz Manager GUI (requires PySide6)                          │
+│ list      List Foxyz versions                                                      │
+│ path      Print the install directory path                                            │
+│ remove    Remove downloaded data. By default, this removes everything.                │
+│           Pass --select to pick a browser version to remove.                          │
+│ server    Launch a Playwright server                                                  │
+│ set       Set the active Foxyz version to use & fetch.                             │
+│           By default, this opens an interactive selector for versions and settings.   │
+│           You can also pass a specifier to activate directly:                         │
+│           Pin version:                                                                │
+│               foxyz set official/stable/134.0.2-beta.20                            │
+│           Automatically find latest in a channel source:                              │
+│               foxyz set official/stable                                            │
+│ sync      Sync available versions from remote repositories                            │
+│ test      Open the Playwright inspector                                               │
+│ version   Display version, package, browser, and storage info                         │
+╰───────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+</details>
+
+### `sync`
+
+Pull a list of release assets from GitHub.
+
+```bash
+> foxyz sync
+Syncing repositories...
+  Official... 24 versions
+  CoryKing... 2 versions
+
+Synced 26 versions from 2 repos.
+```
+
+<hr width=50>
+
+### `set`
+
+Choose a version channel or pin a specific version. Can also be called with a specifier to activate directly.
+
+Interactive selector:
+
+```bash
+> foxyz set
+```
+
+You can also pass a specifier to pin a specific version or choose a channel to follow directly. This will pull the latest stable version from the official repo on `foxyz fetch`.
+
+```bash
+> foxyz set official/stable  # Default setting
+```
+
+Follow latest prerelease version from the official repo, if applicable:
+
+```bash
+> foxyz set official/prerelease
+```
+
+Pin a specific version:
+
+```bash
+> foxyz set official/stable/134.0.2-beta.20
+```
+
+<hr width=50>
+
+### `active`
+
+Prints the current active version string:
+
+```bash
+> foxyz active  # Default channel is active
+official/stable
+```
+
+```bash
+> foxyz set coryking/stable/142.0.1-fork.26
+Pinned: coryking/stable/142.0.1-fork.26
+Run 'foxyz fetch' to install.
+
+> foxyz active  # A specific version is pinned
+coryking/stable/142.0.1-fork.26 (not installed)
+```
+
+<hr width=50>
+
+### `fetch`
+
+Install the latest version from the active channel. By default, this is official/stable. This will also automatically sync repository assets.
+
+```bash
+> foxyz fetch  # Install the latest in the channel
+```
+
+To download the latest from a different channel, or pin a version:
+
+```bash
+> foxyz set coryking/stable
+> foxyz fetch  # Will download the latest release from CoryKing's repo for now on
+```
+
+Or pass in the identifier to download directly without activating it:
+
+```bash
+> foxyz fetch official/stable/135.0-beta.25   # Install a specific version
+```
+
+<hr width=50>
+
+### `list`
+
+List installed or all available Foxyz versions as a tree.
+
+```bash
+> foxyz list          # show installed versions
+> foxyz list all      # show all available versions from synced repos
+> foxyz list --path   # show full install paths
+```
+
+<hr width=50>
+
+### `remove`
+
+By default, removes the entire foxyz data directory.
+
+```bash
+> foxyz remove
+> foxyz remove -y  # skip confirmation prompt
+```
+
+Remove a specific version:
+
+```bash
+> foxyz remove official/stable/134.0.2-beta.20
+```
+
+Interactively select a version to remove:
+
+```bash
+> foxyz remove --select
+```
+
+<hr width=50>
+
+### `version`
+
+Display the Python package version, active browser version, channel, and update status.
+
+```bash
+> foxyz version
+Python Packages
+  Foxyz                    v0.5.0
+  Browserforge                v1.2.4
+  Apify Fingerprints          v0.10.0
+  Playwright                  v1.57.1.dev0+g732639b35.d20251217
+Browser
+  Active                      official/stable/135.0.1-beta.24
+  Current browser             v135.0.1-beta.24
+  Installed                   Yes
+  Latest in official/stable?  Yes
+  Last Sync                   2026-03-07 00:23
+GeoIP
+  Database                    MaxMind GeoLite2
+  Updated                     2026-03-07 00:24
+Storage
+  Install path                /home/name/.cache/foxyz
+  Browser(s) directory size   1.2 GB
+  GeoIP database size         40.7 MB
+  Config file                 /home/name/.cache/foxyz/config.json
+  Repo cache                  /home/name/.cache/foxyz/repo_cache.json
+```
+
+<hr width=50>
+
+### `path`
+
+Print the install directory path.
+
+```bash
+> foxyz path
+/home/name/.cache/foxyz
+```
+
+<hr width=50>
+
+### `test`
+
+Open Foxyz with the Playwright inspector for debugging.
+
+```bash
+> foxyz test
+> foxyz test https://example.com
+```
+
+<hr width=50>
+
+### `server`
+
+Launch a remote Playwright server.
+
+```bash
+> foxyz server
+```
+
+---
+
+## Usage
+
+All of the latest stable documentation is avaliable at [foxyz.com/python](https://github.com/AntifoxyzDev/foxyz).

foxyz-1.0.4/foxyz/__init__.py

@@ -0,0 +1,13 @@
+from .addons import DefaultAddons
+from .async_api import AsyncFoxyz, AsyncNewBrowser
+from .sync_api import Foxyz, NewBrowser
+from .utils import launch_options
+
+__all__ = [
+    "Foxyz",
+    "NewBrowser",
+    "AsyncFoxyz",
+    "AsyncNewBrowser",
+    "DefaultAddons",
+    "launch_options",
+]