Metadata-Version: 2.4
Name: dwellpy
Version: 0.7.1
Summary: Accessibility dwell clicker for motor disabilities
Author: code0nwheels
License: GPL-3.0
Project-URL: Homepage, https://github.com/code0nwheels/dwellpy
Project-URL: Documentation, https://github.com/code0nwheels/dwellpy/wiki
Project-URL: Repository, https://github.com/code0nwheels/dwellpy
Project-URL: Bug Reports, https://github.com/code0nwheels/dwellpy/issues
Keywords: accessibility,dwell,clicker,motor,disabilities,assistive,technology
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Desktop Environment :: Window Managers
Classifier: Topic :: Adaptive Technologies
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt6>=6.4.0
Requires-Dist: pynput>=1.7.6
Dynamic: license-file

# Dwellpy

[![GitHub release](https://img.shields.io/github/v/release/code0nwheels/dwellpy)](https://github.com/code0nwheels/dwellpy/releases)
[![Python Version](https://img.shields.io/badge/python-3.9+-blue.svg)](https://python.org)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

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

**Linux (Automated Install):**
```bash
curl -sSL https://raw.githubusercontent.com/code0nwheels/dwellpy/main/linux-install.sh | bash
```

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

**All Platforms (pip):**
```bash
pip install dwellpy
dwellpy
```

*Standalone executables coming soon for easier installation.*

**Need help?** Check the [setup guides](https://github.com/code0nwheels/dwellpy/wiki) for your operating system.

### For Developers

```bash
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
- **Smart scrolling**: Floating widget for hands-free document navigation
- **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](https://github.com/code0nwheels/dwellpy/wiki):

- [Windows Setup Guide](https://github.com/code0nwheels/dwellpy/wiki/Windows-Setup)
- [macOS Setup Guide](https://github.com/code0nwheels/dwellpy/wiki/macOS-Setup)  
- [Linux Setup Guide](https://github.com/code0nwheels/dwellpy/wiki/Linux-Setup)
- [Configuration Guide](https://github.com/code0nwheels/dwellpy/wiki/Configuration)
- [Troubleshooting](https://github.com/code0nwheels/dwellpy/wiki/Troubleshooting)

## Contributing

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

- **Bug reports**: Use [GitHub Issues](https://github.com/code0nwheels/dwellpy/issues)
- **Feature requests**: Especially accessibility improvements
- **Documentation**: Help improve setup guides
- **Code contributions**: See [CONTRIBUTING.md](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  
│   ├── managers/        # Application state management
│   └── config/          # Configuration and settings
├── docs/                # Documentation
└── tests/               # Test suite (coming soon)
```

## License

GNU General Public License v3.0. See [LICENSE](LICENSE) for details.

---

**Questions?** Check the [wiki](https://github.com/code0nwheels/dwellpy/wiki) or open an [issue](https://github.com/code0nwheels/dwellpy/issues).
