me/omegafox
1
0
Fork 0
mirror of https://forge.fsky.io/oneflux/omegafox.git synced 2026-02-10 17:02:04 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

pythonlib: More parameter documentation

Browse source
This commit is contained in:
daijro 2024-09-19 19:30:37 -05:00
parent f18b9a00be
commit a0e7baf1aa
1 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
pythonlib/README.md
View file

@ -85,29 +85,33 @@ Accepts all Playwright Firefox launch options, along with the following:
Parameters: Parameters:
config (Optional[Dict[str, Any]]): config (Optional[Dict[str, Any]]):
Configuration to use. Camoufox properties to use. (read https://github.com/daijro/camoufox/blob/main/README.md)
addons (Optional[List[str]]):
Addons to use.
fingerprint (Optional[Fingerprint]):
BrowserForge fingerprint to use.
exclude_addons (Optional[List[DefaultAddons]]):
Default addons to exclude. Passed as a list of camoufox.DefaultAddons enums.
screen (Optional[browserforge.fingerprints.Screen]):
BrowserForge screen constraints to use.
os (Optional[ListOrString]): os (Optional[ListOrString]):
Operating system to use for the fingerprint. Either a string or a list of strings. Operating system to use for the fingerprint generation.
user_agent (Optional[ListOrString]): Can be "windows", "macos", or "linux", or a list of these to choose from randomly.
User agent to use for the fingerprint. Either a string or a list of strings. Default: ["windows", "macos", "linux"]
fonts (Optional[List[str]]):
Fonts to load into Camoufox, in addition to the default fonts.
args (Optional[List[str]]):
Arguments to pass to the browser.
block_images (Optional[bool]): block_images (Optional[bool]):
Whether to block all images. Whether to block all images.
block_webrtc (Optional[bool]): block_webrtc (Optional[bool]):
Whether to block WebRTC entirely. Whether to block WebRTC entirely.
firefox_user_prefs (Optional[Dict[str, Any]]): firefox_user_prefs (Optional[Dict[str, Any]]):
Firefox user preferences to set. Firefox user preferences to set.
addons (Optional[List[str]]):
List of Firefox addons to use.
fingerprint (Optional[Fingerprint]):
BrowserForge fingerprint to use.
If not provided, a random fingerprint will be generated based on the provided os & user_agent.
exclude_addons (Optional[List[DefaultAddons]]):
Default addons to exclude. Passed as a list of camoufox.DefaultAddons enums.
user_agent (Optional[ListOrString]):
User agent to use for the fingerprint generation. Either a string or a list of strings.
Note: This must be a valid BrowserForge User-Agent string.
To use a different user agent, set the "navigator.userAgent" preference in `config`.
fonts (Optional[List[str]]):
Fonts to load into Camoufox (in addition to the default fonts for the target `os`).
Takes a list of font family names that are installed on the system.
args (Optional[List[str]]):
Arguments to pass to the browser.
env (Optional[Dict[str, Union[str, float, bool]]]): env (Optional[Dict[str, Union[str, float, bool]]]):
Environment variables to set. Environment variables to set.
executable_path (Optional[str]): executable_path (Optional[str]):