summaryrefslogtreecommitdiff
path: root/doc/build/faq/installation.rst
blob: 7e77a3eb0f839b7f7f3b3386f70e97bbc5df5561 (plain)
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
Installation
=================

.. contents::
    :local:
    :class: faq
    :backlinks: none

.. _faq_asyncio_installation:

I'm getting an error about greenlet not being installed when I try to use asyncio
----------------------------------------------------------------------------------

The ``greenlet`` dependency does not install by default for CPU architectures
for which ``greenlet`` does not supply a `pre-built binary wheel <https://pypi.org/project/greenlet/#files>`_.
Notably, **this includes Apple M1**.    To install including ``greenlet``,
add the ``asyncio`` `setuptools extra <https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-setuptools-extras>`_
to the ``pip install`` command:

.. sourcecode:: text

    pip install sqlalchemy[asyncio]

For more background, see ref_asyncio_install.


.. seealso::

    ref_asyncio_install