Metadata-Version: 2.4
Name: lights-off
Version: 0.1.0
Summary: An accessible Mastodon client for screen reader users, fork of Quinter
Project-URL: Homepage, https://pypi.org/project/lights-off/
Project-URL: Repository, https://github.com/matthewdeanmartin/lights-off
Project-URL: Bug Tracker, https://github.com/matthewdeanmartin/lights-off/issues
Author: Quin and Mason
Author-email: Matthew Martin <matthewdeanmartin@gmail.com>
License: MIT
License-File: LICENSE
Keywords: accessibility,mastodon,screen-reader,wxpython
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Communications
Requires-Python: >=3.12
Requires-Dist: accessible-output2>=0.17; sys_platform == 'darwin'
Requires-Dist: mastodon-py>=2.2.1
Requires-Dist: pyperclip>=1.8
Requires-Dist: sound-lib>=0.8.8; sys_platform != 'linux'
Requires-Dist: tweak>=1.0.4
Requires-Dist: wxpython>=4.2
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: python-dotenv>=1; extra == 'dev'
Requires-Dist: ruff>=0.9; extra == 'dev'
Description-Content-Type: text/markdown

# lights-off

**lights-off** is a lightweight, keyboard-driven, accessible Mastodon client for Windows
and macOS, built with wxPython. It is a fork of
[Quinter](https://github.com/QuinterApp/Quinter), a Twitter client, converted for the
Mastodon network.

Every action is reachable by keyboard shortcut. All content is routed through the platform
screen reader (NVDA/JAWS/SAPI on Windows, VoiceOver on macOS) so blind and low-vision
users can browse, post, and manage their account without touching the mouse.

## Install

```
pipx install lights-off
```

Requires Python 3.12+. See the [installation docs](https://lights-off.readthedocs.io/installation/overview/) for platform-specific steps.

## Run

```
lights-off
```

On first launch you will be prompted for your Mastodon instance URL (e.g.
`https://mastodon.social`) and will complete a one-time OAuth browser flow.

## Documentation

Full documentation is at <https://lights-off.readthedocs.io/>.

- [Installation](https://lights-off.readthedocs.io/installation/overview/)
- [Screen reader setup](https://lights-off.readthedocs.io/screen-readers/overview/)
- [Keyboard reference](https://lights-off.readthedocs.io/getting-started/keyboard-reference/)
- [Troubleshooting](https://lights-off.readthedocs.io/reference/troubleshooting/)

## Development

```bash
git clone https://github.com/matthewdeanmartin/lights-off
cd lights-off
uv sync
uv run lights-off
```

Run tests across all supported Python versions:

```
tox
```

## Contributing

Pull requests welcome. For large feature additions, open an issue first.

## Licenses

- Quinter - no declared license, per Mastodon conversation with Quinn, forking and MIT is okay.
- SAAPI65.dll - (C) All rights reserved
- nvdaControllerClient64.dll LGPL
- GPL-2.0-only. `Tolk.py` is LGPLv3 (copyright Davy Kager).
- .ogg soundfiles - unknown license
- keyboard_handler - vendorized, MIT, copyright Christopher Toth