Metadata-Version: 2.1
Name: buttplug-py
Version: 0.1.1
Summary: Python client implementation of the Buttplug Intimate Hardware Control Protocol.
Author-email: Siege Wizard <wizard.siege@gmail.com>
License: Buttplug-py is covered under the following BSD 3-Clause License
        
        Copyright (c) 2022, Siege-Wizard
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: Homepage, https://github.com/siege-wizard/buttplug-py
Project-URL: Bug Tracker, https://github.com/siege-wizard/buttplug-py/issues
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# buttplug-py

[![PyPi version](https://img.shields.io/pypi/v/buttplug-py)](http://pypi.org/project/buttplug-py)
[![Python version](https://img.shields.io/pypi/pyversions/buttplug-py)](http://pypi.org/project/buttplug-py)
[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)

Buttplug-py is a python implementation of the Client of the Buttplug Sex Toy Control Protocol.
It allows users to write applications that can connect to Buttplug Servers, such as
[Intiface Central](https://github.com/intiface/intiface-central) or
[Intiface CLI](https://github.com/intiface/intiface-engine).

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

## Officiality

Buttplug-py is not officially supported by the developers of Buttplug, it is a community maintained project.
There is an outdated official Python client that can be found in
[buttplugio/buttplug-py](https://github.com/buttplugio/buttplug-py).

## Table Of Contents

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

## Support The Project

If you find this project helpful you can [support me via Ko-Fi](https://ko-fi.com/siegewizard).
Every donation helps to maintain this library up to date and adding new features.

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/siegewizard)

[Buttplug developer's Patreon](http://patreon.com/qdot) can be used if you wish to support the Buttplug project.

## Documentation

Currently, the documentation of the library is limited to class and methods documentations. The main entrypoint is the
Client class which will guide the reader forward.

## Examples

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

## License

Buttplug-py is BSD 3-Clause licensed. More information is available in the [LICENSE file](LICENSE).

## Changelog

The full changelog can be found [here](CHANGELOG.md).
