Skip to main content

Bumblebee

PyPI Python License

Human-like mouse and keyboard automation for Python.

Bumblebee gives you a small runtime API for moving the mouse, clicking, dragging, scrolling, typing, shortcuts, clipboard actions, and optional RL-generated cursor paths. The base install stays lightweight; Torch and Stable-Baselines3 are only installed when you ask for RL support.

Install

pip install the-bumblebee

or with uv:

uv add the-bumblebee

To use the packaged RL mouse policy:

pip install "the-bumblebee[rl]"
# or
uv add "the-bumblebee[rl]"

Quick start

Mouse

from bumblebee import Mouse, MouseBounds

mouse = Mouse(fail_safe=True)
mouse.set_profile("natural")
mouse.set_speed(1200)

mouse.move(500, 300)
mouse.click()
mouse.drag_to(700, 450)
mouse.scroll(-3)

# Click a random safe point inside a UI rectangle.
mouse.click_in_bounds(MouseBounds(100, 200, 260, 240), padding=6)

Keyboard

from bumblebee import Keyboard

keyboard = Keyboard()
keyboard.set_profile("careful")
keyboard.type("Hello from Bumblebee.", wpm=70, typo_rate=1)
keyboard.hotkey("cmd", "a")  # use "ctrl" on Windows/Linux

Packaged RL mouse policy

from bumblebee import Mouse
from bumblebee.rl.policy import SB3MousePolicyPathProvider

provider = SB3MousePolicyPathProvider.from_packaged(deterministic=False)
mouse = Mouse(path_provider=provider, fail_safe=True)
mouse.move(700, 450)

What is included

  • Mouse movement, clicking, dragging, scrolling, and bounded clicks
  • Keyboard typing, hotkeys, copy/paste, undo/redo, and multi-line helpers
  • Configurable movement and typing profiles
  • Custom mouse path providers
  • Optional packaged SAC mouse policy for RL-generated paths
  • Local tooling for preparing data, training, and visualizing mouse policies

Documentation

Topic Link
Installation docs/installation.md
Mouse API docs/mouse.md
Keyboard API docs/keyboard.md
Examples docs/examples.md
RL workflow docs/rl-workflow.md
Architecture docs/architecture.md
Model and release assets docs/models-and-releases.md
Publishing PUBLISHING.md
Security SECURITY.md

Development

git clone https://github.com/arpan404/bumblebee.git
cd bumblebee
uv sync --group dev

uv run black --check .
uv run isort --check-only .
uv run python -m compileall scripts src
uv build
uv run twine check dist/*

For RL training tools:

uv sync --group train

Model and dataset policy

The wheel includes the default model:

bumblebee/models/sac_mouse_v2.zip

Datasets, checkpoints, replay buffers, TensorBoard logs, and other large training artifacts are not included in the wheel. Release artifacts live on GitHub Releases.

Safety

  • Mouse(fail_safe=True) is the default.
  • Move the cursor to a screen corner to trigger PyAutoGUI's fail-safe.
  • Only automate systems and applications you are allowed to control.
  • Be careful with real clicks, typing, and clipboard operations.

On macOS, you may need to grant Accessibility permission to your terminal, Python, or IDE.

Contributing

Contributions are welcome. Start with CONTRIBUTING.md.

Release files for the-bumblebee 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for the-bumblebee 2.0.1
File Size Uploaded
the_bumblebee-2.0.1.tar.gz 6.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for the-bumblebee 2.0.1
File Interpreter ABI Platform
the_bumblebee-2.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 12.0 MB

Release files / the_bumblebee-2.0.1.tar.gz

Download URL the_bumblebee-2.0.1.tar.gz
Size 6.0 MB
Tags Source
SHA-256 checksum
How to use checksums
5b78090574bb91408d66239ea5f97df3290b04a0c911276d4b534fd0a0b1f44b
BLAKE2b-256 checksum
How to use checksums
ec08792b824c20d5bb1e44079e02d58186fdc971dbd9f2e2868343ec8a1c9b6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 24, 2026.

Transparency log

Release files / the_bumblebee-2.0.1-py3-none-any.whl

Download URL the_bumblebee-2.0.1-py3-none-any.whl
Size 6.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f6d7a11027db3f238bd1ee05d0ace81f5527a1f1ee446c1cac1853c5593fc205
BLAKE2b-256 checksum
How to use checksums
fe104bbbc73a5420223a663c97485f42dd62b254f3c229974d7acbdeb6d682f9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 24, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

2.0.1 This release

2 release files

2.0.0

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page