OxyMouse

https://pypi.org/project/oxymouse/
Admin
OxyMouse is a Python library for generating realistic mouse movements using multiple algorithms like...
Tokens:1,954
Snippets:29
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Installation

Source: https://pypi.org/project/oxymouse/1.1.0

Install the OxyMouse library using pip.

```APIDOC
## Installation

```
pip install oxymouse
```
```

--------------------------------

### Install oxymouse Package

Source: https://pypi.org/project/oxymouse

Use pip to install the oxymouse library. This is the initial step before using any of its functionalities.

```bash
pip install oxymouse
```

--------------------------------

### generate_coordinates

Source: https://pypi.org/project/oxymouse/1.1.0

Generates coordinates to move from a starting point to a destination point.

```APIDOC
#### generate_coordinates

This method will generate random coordinates from a given 2D point to another 2D point.
You can use this to generate movements to a button.
For example:
  * get button coordinates
  * get current mouse coordinates
  * generate movements from current mouse coordinates to button coordinates

```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_coordinates(from_x=400, from_y=500, to_x=1000, to_y=1200)
```
```

--------------------------------

### OxyMouse Coordinate Generation Between Two Points

Source: https://pypi.org/project/oxymouse

Generates mouse movements from a starting 2D point to a destination 2D point.

```APIDOC
## OxyMouse Coordinate Generation Between Two Points

### Description
Generates mouse movements from a starting 2D point to a destination 2D point. This is useful for moving the mouse cursor to a specific element like a button.

### Usage
```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_coordinates(from_x=400, from_y=500, to_x=1000, to_y=1200)
```

### Parameters
- `algorithm` (string): The algorithm to use for generating mouse movements.
- `from_x` (int): The starting X-coordinate.
- `from_y` (int): The starting Y-coordinate.
- `to_x` (int): The destination X-coordinate.
- `to_y` (int): The destination Y-coordinate.
```

--------------------------------

### Generate Coordinates Between Two Points

Source: https://pypi.org/project/oxymouse

Use the generate_coordinates method to create mouse movements from a starting point (from_x, from_y) to an ending point (to_x, to_y). This is useful for simulating clicks on specific elements.

```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_coordinates(from_x=400, from_y=500, to_x=1000, to_y=1200)
```

--------------------------------

### Testing Visualizations

Source: https://pypi.org/project/oxymouse/1.1.0

Instructions on how to test generated mouse movements visually using the provided CLI script.

```APIDOC
## Testing

You can easily test generated mouse movements visually with specific algorithm.
Use the CLI to test the generated mouse movements.
For example, to test the generated mouse movements with the `Bezier` algorithm and `generate_coordinates` function.
```
python3 visualize.py bezier gc
```

You will see the generated mouse movements in a window. Similar in the examples above.
Other function names:
```
function_names_to_function_map = {
    "gc": "generate_coordinates",
    "grc": "generate_random_coordinates",
    "gsc": "generate_scroll_coordinates",
}
```
```

--------------------------------

### Basic Usage

Source: https://pypi.org/project/oxymouse/1.1.0

Initialize OxyMouse with a chosen algorithm and generate random coordinates.

```APIDOC
## Usage

Specify `algorithm` an algorithm.
Supported algorithms:
`bezier`, `gaussian`, `perlin`
```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_random_coordinates(viewport_width=1920, viewport_height=1080)
```
```

--------------------------------

### Test Bezier Algorithm with generate_coordinates CLI

Source: https://pypi.org/project/oxymouse

Execute a Python script from the command line to visualize mouse movements generated by the Bezier algorithm using the 'generate_coordinates' function.

```bash
python3 visualize.py bezier gc
```

--------------------------------

### Supported Algorithms

Source: https://pypi.org/project/oxymouse/1.1.0

Details on the different algorithms available for generating mouse movements.

```APIDOC
## Supported Algorithms

### Bezier
The Bezier algorithm generates mouse movements using the Bezier curve. Perfect for moving to click a button

### Gaussian
The Gaussian algorithm generates mouse movements using the Gaussian distribution. Perfect for simulating human-like mouse movements

### Perlin
The Perlin algorithm generates mouse movements using the Perlin noise. Perfect for simulating human-like mouse movements
```

--------------------------------

### OxyMouse Initialization and Random Coordinate Generation

Source: https://pypi.org/project/oxymouse

Initializes the OxyMouse with a specified algorithm and generates random coordinates within the viewport dimensions.

```APIDOC
## OxyMouse Initialization and Random Coordinate Generation

### Description
Initializes the OxyMouse with a specified algorithm and generates random coordinates within the viewport dimensions.

### Usage
```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_random_coordinates(viewport_width=1920, viewport_height=1080)
```

### Parameters
- `algorithm` (string): The algorithm to use for generating mouse movements (e.g., "bezier", "gaussian", "perlin").
- `viewport_width` (int): The width of the viewport.
- `viewport_height` (int): The height of the viewport.
```

--------------------------------

### Generate Random Coordinates with Bezier Algorithm

Source: https://pypi.org/project/oxymouse

Instantiate OxyMouse with the 'bezier' algorithm and generate random coordinates within the specified viewport dimensions.

```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_random_coordinates(viewport_width=1920, viewport_height=1080)
```

--------------------------------

### Function Name Mapping for CLI

Source: https://pypi.org/project/oxymouse

A dictionary mapping short command-line interface (CLI) aliases to their corresponding function names within the OxyMouse library.

```python
function_names_to_function_map = {
    "gc": "generate_coordinates",
    "grc": "generate_random_coordinates",
    "gsc": "generate_scroll_coordinates",
}
```

--------------------------------

### Generate Scroll Coordinates

Source: https://pypi.org/project/oxymouse

Generate coordinates specifically for simulating mouse scrolling actions using the chosen algorithm.

```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_scroll_coordinates()
```

--------------------------------

### OxyMouse Scroll Coordinate Generation

Source: https://pypi.org/project/oxymouse

Generates coordinates specifically for simulating mouse scrolling.

```APIDOC
## OxyMouse Scroll Coordinate Generation

### Description
Generates coordinates specifically for simulating mouse scrolling actions.

### Usage
```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_scroll_coordinates()
```

### Parameters
- `algorithm` (string): The algorithm to use for generating mouse movements.
```

--------------------------------

### generate_scroll_coordinates

Source: https://pypi.org/project/oxymouse/1.1.0

Generates coordinates suitable for simulating mouse scrolling.

```APIDOC
#### generate_scroll_coordinates

This method will generate random coordinates for scrolling.
```python
from oxymouse import OxyMouse

mouse = OxyMouse(algorithm="bezier")
movements = mouse.generate_scroll_coordinates()
```
```

--------------------------------

### generate_random_coordinates

Source: https://pypi.org/project/oxymouse/1.1.0

Generates random coordinates within the specified viewport dimensions.

```APIDOC
#### generate_random_coordinates

This method will generate random coordinates based on your viewport width and viewport height.
```
Tokens:
Raw