Metadata-Version: 2.1
Name: digi-xbee
Version: 1.4.1
Summary: Digi XBee Python library
Home-page: https://github.com/digidotcom/xbee-python
Author: Digi International Inc.
Author-email: tech.support@digi.com
License: Mozilla Public License 2.0 (MPL 2.0)
Project-URL: Documentation, https://xbplib.readthedocs.io
Project-URL: Source, https://github.com/digidotcom/xbee-python
Project-URL: Tracker, https://github.com/digidotcom/xbee-python/issues
Keywords: xbee,IOT,wireless,radio frequency
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Home Automation
Classifier: Topic :: Games/Entertainment
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Requires-Python: >=3, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*
Description-Content-Type: text/x-rst
Provides-Extra: SRP
License-File: LICENSE.txt

Digi XBee Python library |pypiversion| |pythonversion|
======================================================

This project contains the source code of the XBee Python library, an
easy-to-use API developed in Python that allows you to interact with Digi
International's `XBee <https://www.digi.com/xbee>`_ radio frequency (RF)
modules.

This source has been contributed by Digi International.


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

You can install XBee Python library using `pip
<https://pip.pypa.io/en/stable/>`_::

    $ pip install digi-xbee


Install from Source
-------------------

You can install XBee Python library directly from sources. To do so, extract
the source code to your computer and execute the following command::

    $ pip install <path_to_xbee-python_dir>


Documentation
-------------

XBee Python library has user guide and API reference documentation hosted on
Read the Docs. You can find the latest, most up to date, documentation at
`latest docs <https://xbplib.readthedocs.io/en/latest/>`_. To see only those
features which have been released, check out the
`stable docs <https://xbplib.readthedocs.io/en/stable/>`_.


How to contribute
-----------------

The contributing guidelines are in the `CONTRIBUTING.rst document
<https://github.com/digidotcom/xbee-python/blob/master/CONTRIBUTING.rst>`_.


License
-------

Copyright 2017-2021, Digi International Inc.

The `MPL 2.0 license <https://github.com/digidotcom/xbee-python/blob/master/LICENSE.txt>`_
covers the majority of this project with the following exceptions:

* The `ISC license <https://github.com/digidotcom/xbee-python/blob/master/examples/LICENSE.txt>`_
  covers the contents of the examples directory.

.. |pypiversion| image:: https://badge.fury.io/py/digi-xbee.svg
    :target: https://pypi.org/project/digi-xbee/
.. |pythonversion| image:: https://img.shields.io/pypi/pyversions/digi-xbee.svg
    :alt: PyPI - Python Version


