File: installation.rst

package info (click to toggle)
bleak 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,828 kB
  • sloc: python: 10,660; makefile: 165; java: 105
file content (49 lines) | stat: -rw-r--r-- 1,381 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.. highlight:: shell

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


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

To install bleak, run this command in your terminal:

.. code-block:: console

    $ pip install bleak

This is the preferred method to install bleak, 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/hbldh/bleak/archive/refs/heads/develop.zip

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


Pythonista iOS app
^^^^^^^^^^^^^^^^^^
Use `StaSh <https://github.com/ywangd/stash>`_
or `Pythonista3_pip_Configration_Tool <https://github.com/CrossDarkrix/Pythonista3_pip_Configration_Tool>`_ for pip

.. code-block:: console

    $ pip install bleak[pythonista]

It should install ``bleak`` and ``bleak-pythonista``
Then use bleak as common :doc:`usage` or refer to `bleak-pythonista docs <https://github.com/o-murphy/bleak-pythonista/blob/master/docs/pythonista.rst>`_