.. highlight:: shell

============
Installation
============


Stable release
--------------

To install python-switchbot-ble, run this command in your terminal:

.. code-block:: console

    $ pip install python-switchbot-ble


This is the preferred method to install python-switchbot-ble, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


Develop branch
--------------

The develop branch can also be installed using ``pip``. This is useful for
testing the latest changes before they reach the stable release.

.. code-block:: console

    $ pip install https://github.com/carlsondev/python-switchbot-ble/archive/refs/heads/develop.zip

For checking out a copy of SwitchBot BLE for developing SwitchBot BLE itself, see the :doc:`contributing` page.