clickpy 0.3.1a0

Automated mouse clicking script

clickpy

Automated mouse clicker script.

Dependencies

Using Poetry to manage the virtual environment and packages. I also highly recommend using Pyenv to install and manage your python interpreters.

This script uses pyautogui for clicking and Typer for CLI parsing.

Installation

TODO: Work in Progress (still figuring out packaging and installation.)

Development

TODO: Fix this section

Testing

This project utilizes pytest and pytest-mock. Both should be included in pyproject.toml dev dependencies, and .vscode/settings.json should already be setup to use these libraries.

Please type annotate any mocks used, which should be MockerFixture if you use pytest-mock.

Scripts

# define your local python version
pyenv local 3.9.6

# install all deps from pyproject.toml
poetry install

# activate virtual environment first
poetry shell
# run tests, also outputs code coverage
python -m pytest -v --cov=clickpy --capture=sys tests/

# run this to generate report
coverage html

# open html coverage doc, windows doesn't have open.
[ -x "$(command -v open)" ] && open htmlcov/index.html || start htmlcov/index.html

# same command for fish shell
[ -x (command -v open) ] && open htmlcov/index.html || start htmlcov/index.html