Metadata-Version: 2.4
Name: clickpy
Version: 1.0.0
Summary: A library able to control mouse for auto-clicking
Home-page: https://github.com/donno2048/clickpy
Author: Elisha Hollander
Author-email: just4now666666@gmail.com
License: MIT
Project-URL: Documentation, https://github.com/donno2048/clickpy#readme
Project-URL: Bug Reports, https://github.com/donno2048/clickpy/issues
Project-URL: Source Code, https://github.com/donno2048/clickpy
Platform: win32
Classifier: Environment :: Win32 (MS Windows)
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: project-url
Dynamic: summary

# clickpy

A library able to control mouse (mainly for auto-clicking)

## Installation

> [!WARNING]
> The package will be installed on non-Windows platforms with no errors.
> 
> This is for automation purposes only, as the package will only work on Windows.

### From PyPI

```sh
pip3 install clickpy
```

### From GitHub

```sh
pip3 install git+https://github.com/donno2048/clickpy
```

## Usage

Here's the method listing for the package.

 - `click_here`: The method will create a click at the current location

Example usage:

```py
from clickpy import click_here
click_here()
```

 - `click_at`: The method will create a click at the specified (x,y) coordinates

Example usage:

```py
from clickpy import click_at
click_at((0,0))
```

- `clicks_here`: The method will create a certain amount of click at the current location
The method has a number of optional keyword arguments:
   * `ms_delay` - the delay in milliseconds between the clicks [default: at fast as the OS allows]
   * `total_clicks` - the total clicks to be sent [default: infinitely many]
   * `key_stop` - a virtual key code that when entered in the keyboard the clicks will stop at once - e.g. `ord('a'.upper())` to stop on `a` key press [default: stop only after `total_clicks` clicks]
   * `key_start` - similar to `key_stop` but for starting the clicks [default: start immediately]
   * `stop_modifier` - the modifier (e.g. `ALT`, `CONTROL`, `SHIFT` and `WIN`) for `key_stop`
   * `start_modifier` - the modifier for `key_start`

Example usage:

```py
from clickpy import clicks_here, SHIFT, ALT
# will start clicking at the cursor's position one million times with 10ms delay in between when 0 is pressed and stop upon SHIFT+ALT+0
clicks_here(ms_delay=10, total_clicks=1_000_000, key_stop=ord('0'), key_start=ord('0'), stop_modifier=SHIFT|ALT)
```

 - `clicks_at`: The method will create a certain amount of clicks at the specified location
The method expects the same (optional) keyword arguments as `clicks_here` but also a (x,y) coordinates tuple which can be provided as a positional argument or as the `position` keyword

Example usage:

```py
from clickpy import clicks_at, SHIFT, ALT
# same as the clicks_here example but at (0,0)
clicks_at((0,0), ms_delay=10, total_clicks=1_000_000, key_stop=ord('0'), key_start=ord('0'), stop_modifier=SHIFT|ALT)
```
