Metadata-Version: 2.1
Name: simplepyble
Version: 0.7.0
Summary: The ultimate fully-fledged cross-platform BLE library, designed for simplicity and ease of use.
Home-page: https://github.com/OpenBluetoothToolbox/SimpleBLE
Author: Kevin Dewald
Author-email: kevin@dewald.me
Platform: Windows
Platform: macOS
Platform: Linux
Classifier: License :: OSI Approved :: BSD License
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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 :: Only
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE.md

SimplePyBLE
===========

The ultimate fully-fledged cross-platform bindings for Bluetooth Low Energy (BLE).

|Latest Documentation Status| |PyPI Licence|

Overview
--------

SimplePyBLE provides Python bindings for `SimpleBLE`_, a fully cross-platform BLE
library written in C++. It is designed for simplicity and ease of use with a
licencing scheme chosen to be friendly towards commercial use.

If you want to use SimpleBLE and need help. **Please do not hesitate to reach out!**

* Visit our `ReadTheDocs`_ page.
* Join our `Discord`_ server.
* Contact me: ``kevin at dewald dot me``

Are you using SimplePyBLE on your own project and would like to see it featured here?
Reach out and I'll add a link to it below!

Supported platforms
-------------------
=========== ============= =================================== =====
Windows     Linux         MacOS                               iOS
=========== ============= =================================== =====
Windows 10+ Ubuntu 20.04+ 10.15+ (except 12.0, 12.1 and 12.2) 15.0+
=========== ============= =================================== =====

**NOTE:** WSL does not support Bluetooth.

Installation
------------

You can install SimplePyBLE from PyPI using pip: ::

   pip install simplepyble

Please review our `code examples`_ on GitHub for more information on how to use
SimplePyBLE.

Contributing
------------
Pull requests are welcome. For major changes, please open an issue first to discuss
what you would like to change.

License
-------

All components within this project that have not been bundled from
external creators, are licensed under the terms of the `MIT Licence`_.

.. Links

.. _SimplePyBLE: https://pypi.org/project/simplepyble/

.. _SimpleBLE: https://github.com/OpenBluetoothToolbox/SimpleBLE/

.. _code examples: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble

.. _MIT Licence: https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/LICENCE.md

.. _Discord: https://discord.gg/N9HqNEcvP3

.. _ReadTheDocs: https://simpleble.readthedocs.io/en/latest/

.. |Latest Documentation Status| image:: https://readthedocs.org/projects/simpleble/badge?version=latest
   :target: http://simpleble.readthedocs.org/en/latest

.. |PyPI Licence| image:: https://img.shields.io/pypi/l/simplepyble
