Skip to main content

A Python SDK for spacemouse functionality

Project description

Spacemouse SDK

A Python SDK for spacemouse functionality.

Installation

You can install the package from PyPI:

pip install spacemouse-sdk

Or install from source:

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

Usage

import spacemouse_sdk

# Example usage
client = spacemouse_sdk.SpacemouseClient()
client.connect()

Development

Setup Development Environment

  1. Clone the repository:
git clone https://github.com/simonfall/spacemouse-sdk.git
cd spacemouse-sdk
  1. Create a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install development dependencies:
pip install -e ".[dev]"

Running Tests

pytest

Code Formatting

black src tests
isort src tests

Type Checking

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 file for details.

Changelog

See CHANGELOG.md for a list of changes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spacemouse_sdk-0.1.1.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spacemouse_sdk-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file spacemouse_sdk-0.1.1.tar.gz.

File metadata

  • Download URL: spacemouse_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for spacemouse_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 05041e4bb54d56756e5d41c98635246cd17b5f2830881ce50afc216fa2939e41
MD5 20844e4577247a397848f34d22348942
BLAKE2b-256 b8b74607163899a150b1305bb3830c2638caed18334fa3fd7574467c485068b7

See more details on using hashes here.

File details

Details for the file spacemouse_sdk-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: spacemouse_sdk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for spacemouse_sdk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e7c7ab98033a699b488bef5f99adbb25ce08e0b034e210011c8b8d9b464e9a8
MD5 25284daf287196935562cba0f282d109
BLAKE2b-256 2b058cc597684d13e4f0b6e150468e11fa5a136e6572178821da9fe816e346c3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page