Skip to content

Cross-platform accessibility tool that enables mouse clicking by hovering (dwelling) instead of physical clicks. Designed for people with motor disabilities who use head trackers or have conditions affecting hand movement.

License

Notifications You must be signed in to change notification settings

code0nwheels/Dwellpy

Repository files navigation

Dwellpy

GitHub release Python Version License: GPL v3

Click by hovering instead of pressing mouse buttons. Dwellpy automatically performs clicks when you position your cursor over a target and wait briefly.

Built for users with motor disabilities who use head trackers, eye-tracking systems, or have difficulty with traditional mouse clicking due to conditions like cerebral palsy, hand tremors, or muscular dystrophy.

Made by a disabled person for the disabled community.

Quick Start

For End Users

Option 1: Installers and Executables (Easiest)

Download the installer or executable for your platform:

  • Windows: Download the installer from latest releases - look for dwellpy-installer-*-windows-x64.exe
  • macOS: Download from latest releases - look for dwellpy-*-macos.dmg or dwellpy-*-macos-x64
  • Linux: For Debian-based systems (Ubuntu, Mint, etc.), download the .deb package from latest releases (e.g., dwellpy-*-linux-debian-x64.deb). For other distributions, or for a scripted setup, see the Linux Setup Guide.

The Windows installer provides a professional installation experience with Start Menu integration and automatic shortcuts. For macOS, the DMG offers a standard installation. For Linux, the .deb package integrates with your system's package manager. See setup guides for detailed platform-specific instructions.

Option 2: Package Managers

Linux (Automated Install):

curl -sSL https://raw.githubusercontent.com/code0nwheels/dwellpy/main/utils/linux-install.sh | bash

To uninstall:

curl -sSL https://raw.githubusercontent.com/code0nwheels/dwellpy/main/utils/linux-uninstall.sh | bash

All Platforms (pip):

pip install dwellpy
dwellpy

Need help? Check the setup guides for your operating system.

For Developers

git clone https://github.com/code0nwheels/dwellpy.git
cd dwellpy
pip install -r requirements.txt
python -m dwellpy.main

What it does

  • Multiple click types: Left, right, double-click, and drag operations
  • Floating widgets: Menu and scroll widgets that appear when you dwell (pause cursor)
  • Visual feedback: Customizable click animations with distinctive colors for each action type
  • Organized settings: Tabbed interface with logical grouping (Dwell, Visual, Scroll, General)
  • Dwell-friendly controls: Large buttons with hover functionality for easy adjustment
  • Auto-collapse UI: Minimize screen clutter with intelligent toolbar behavior
  • Configurable: Adjust sensitivity for different motor abilities and use cases
  • Cross-platform: Windows, macOS, and Linux support

Documentation

Detailed guides are available in the project wiki:

Contributing

This project was created by and for the disability community. We welcome:

  • Bug reports: Use GitHub Issues
  • Feature requests: Especially accessibility improvements
  • Documentation: Help improve setup guides
  • Code contributions: See CONTRIBUTING.md

Development Setup

  1. Fork the repository
  2. Create a virtual environment: python -m venv venv
  3. Activate it: source venv/bin/activate (Linux/Mac) or venv\Scripts\activate (Windows)
  4. Install dependencies: pip install -r requirements.txt
  5. Run tests: python -m pytest (when available)
  6. Make your changes and submit a pull request

Project Structure

dwellpy/
├── dwellpy/              # Main application package
│   ├── core/            # Dwell detection and input handling
│   ├── ui/              # User interface components (including menu widget)
│   ├── managers/        # Application state management
│   └── config/          # Configuration and settings
├── docs/                # Documentation
└── tests/               # Test suite (coming soon)

License

GNU General Public License v3.0. See LICENSE for details.


Questions? Check the wiki or open an issue.

About

Cross-platform accessibility tool that enables mouse clicking by hovering (dwelling) instead of physical clicks. Designed for people with motor disabilities who use head trackers or have conditions affecting hand movement.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •