Metadata-Version: 2.1
Name: buttplug
Version: 0.2.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
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)
[![Discourse Forum](https://img.shields.io/badge/discourse-forum-blue.svg)](https://metafetish.club)
[![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
[C# CLI](https://github.com/intiface/intiface-cli-csharp) or [Node
CLI](https://github.com/intiface/intiface-cli-node).

A python-based Buttplug server is certainly possible, and may happen
in the future. For the moment, we are mostly trying to make it easier
for people to write Buttplug applications in python that can access
the already existing server implementations.

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

## 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)! 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.
