Metadata-Version: 2.1
Name: buttplug
Version: 0.3.0
Summary: Python implementation of the Buttplug Intimate Hardware Control Protocol.
Home-page: https://github.com/buttplugio/buttplug-py
Author: Nonpolynomial
Author-email: kyle@nonpolynomial.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# buttplug-py

[![PyPi version](https://img.shields.io/pypi/v/buttplug)](http://pypi.org/project/buttplug)
[![Python version](https://img.shields.io/pypi/pyversions/buttplug)](http://pypi.org/project/buttplug)

[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)
[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)

Buttplug-py is a python implementation of the Core and Client portions of the Buttplug Sex Toy
Control Protocol. It allows users to write applications that can connect to Buttplug Servers, such
as the [Intiface Desktop Application](https://github.com/intiface/intiface-desktop) or [Intiface Rust CLI](https://github.com/intiface/intiface-cli-rs).

For more information on the Buttplug project, check out the project website at
[https://buttplug.io](https://buttplug.io).

## NO LONGER DEPRECATED

If you're thinking "but wasn't buttplug-py deprecated?"... Yeah it was but honestly it works and converting to the new rust FFI is going to take a while and it hasn't been on my todo list in well over a year, so we'll actually just call this still in production for now.

## Table Of Contents

- [Support The Project](#support-the-project)
- [Documentation](#documentation)
- [Examples](#examples)
- [License](#license)

## Support The Project

If you find this project helpful, you can [support us via Patreon](http://patreon.com/qdot) or
[Github Sponsors](http://github.com/sponsors/qdot)! Every donation helps us afford more hardware to
reverse, document, and write code for!

## Documentation

Library and API Documentation for buttplug-py is available at

https://buttplug-py.docs.buttplug.io

Other recommended reading includes

- [The Buttplug Protocol Spec](https://buttplug-spec.docs.buttplug.io)
- [The Buttplug Developer Guide](https://buttplug-developer-guide.docs.buttplug.io)

## Examples

Example code is available in the examples/ directory. Examples are heavily commented to hopefully
make usage of the library clearer.

## License

Buttplug is BSD 3-Clause licensed. More information is available in the LICENSE file.


