1  Introduction
 2  ============
 3  
 4  .. image:: https://readthedocs.org/projects/circuitpython-tinylora/badge/?version=latest
 5      :target: https://circuitpython.readthedocs.io/projects/tinylora/en/latest/
 6      :alt: Documentation Status
 7  
 8  .. image:: https://img.shields.io/discord/327254708534116352.svg
 9      :target: https://adafru.it/discord
10      :alt: Discord
11  
12  .. image:: https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa/workflows/Build%20CI/badge.svg
13      :target: https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa/actions/
14      :alt: Build Status
15  
16  LoRaWAN/The Things Network, for CircuitPython.
17  
18  Dependencies
19  =============
20  This driver depends on:
21  
22  * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
23  * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
24  
25  Please ensure all dependencies are available on the CircuitPython filesystem.
26  This is easily achieved by downloading `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
27  
28  Installing from PyPI
29  ====================
30  
31  On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
32  PyPI <https://pypi.org/project/adafruit-circuitpython-tinylora/>`_. To install for current user:
33  
34  .. code-block:: shell
35  
36      pip3 install adafruit-circuitpython-tinylora
37  
38  To install system-wide (this may be required in some cases):
39  
40  .. code-block:: shell
41  
42      sudo pip3 install adafruit-circuitpython-tinylora
43  
44  To install in a virtual environment in your current project:
45  
46  .. code-block:: shell
47  
48      mkdir project-name && cd project-name
49      python3 -m venv .env
50      source .env/bin/activate
51      pip3 install adafruit-circuitpython-tinylora
52  
53  Usage Example
54  =============
55  
56  Usage is described in the `learn guide for this library <https://learn.adafruit.com/using-lorawan-and-the-things-network-with-circuitpython>`_.
57  
58  
59  
60  Contributing
61  ============
62  
63  Contributions are welcome! Please read our `Code of Conduct
64  <https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa/blob/master/CODE_OF_CONDUCT.md>`_
65  before contributing to help this project stay welcoming.
66  
67  Documentation
68  =============
69  
70  For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
71  
72  License
73  =======
74  This library was written by ClemensRiederer. We've converted it to work with Adafruit CircuitPython and made
75  changes so it works with the Raspberry Pi and Adafruit Feather M0/M4. We've added examples for using this library
76  to transmit data and sensor data to The Things Network.
77  
78  This open source code is licensed under the LGPL license (see LICENSE for details).