Metadata-Version: 2.4
Name: spacemouse-sdk
Version: 0.1.0
Summary: A Python SDK for spacemouse functionality
Author-email: Simon Fall <your.email@example.com>
Maintainer-email: Simon Fall <your.email@example.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/simonfall/spacemouse
Project-URL: Documentation, https://github.com/simonfall/spacemouse#readme
Project-URL: Repository, https://github.com/simonfall/spacemouse.git
Project-URL: Bug Tracker, https://github.com/simonfall/spacemouse/issues
Keywords: spacemouse,input,device,sdk,3d-mouse
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
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: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=22.0; extra == "dev"
Requires-Dist: isort>=5.0; extra == "dev"
Requires-Dist: flake8>=4.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=4.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
Dynamic: license-file

# Spacemouse SDK

A Python SDK for spacemouse functionality.

## Installation

You can install the package from PyPI:

```bash
pip install spacemouse-sdk
```

Or install from source:

```bash
git clone https://github.com/simonfall/spacemouse.git
cd spacemouse
pip install -e .
```

## Usage

```python
import spacemouse

# Example usage
client = spacemouse.SpacemouseClient()
client.connect()
```

## Development

### Setup Development Environment

1. Clone the repository:
```bash
git clone https://github.com/simonfall/spacemouse.git
cd spacemouse
```

2. Create a virtual environment:
```bash
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
```

3. Install development dependencies:
```bash
pip install -e ".[dev]"
```

### Running Tests

```bash
pytest
```

### Code Formatting

```bash
black src tests
isort src tests
```

### Type Checking

```bash
mypy src
```

## Contributing

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a list of changes.
