Navigation

Install Reahl

The bottom line

Reahl itself is installed via pip, using extras in [] to select what you want:

pip3 install reahl[declarative,sqlite,dev,doc]

On platforms other than Windows, some dependencies pulled in during installation will also need to be compiled. To be able to compile these, you will also need:

  • Libxml, libxslt

  • Libsqlite

  • Python headers for compiling the above

  • A C/C++ compiler (such as gcc)

  • Cython

This version of Reahl requires version 3.6 of Python or greater.

Reahl depends on a lot of other software. Installing it is not just a straight pip3 install reahl. You need to install a couple of other things first.

If you know Docker then use our Docker dev box. It contains a virtualenv with Reahl installed. Otherwise, follow the instructions below:

  1. Prepare your platform

  1. Create a virtualenv

    On Linux or Mac, do:

    python3 -m venv ./reahl_env

    On Windows, do (in a command shell):

    python3 -m venv reahl_env

    This creates a new directory reahl_env with an isolated Python environment inside it.

  2. Activate the virtualenv

    On Linux or Mac:

    source ./reahl_env/bin/activate

    On Windows:

    reahl_env\Scripts\activate.ps1

    Your prompt should change to reflect the active virtual environment.

  3. Install Reahl in the virtualenv

    With your virtualenv activated, install Reahl:

    pip3 install reahl[declarative,sqlite,dev,doc]

    Reahl is composed of different components—you only need some of them. The pip extras (given in [] above) let you choose what to install.

    You can install:

    declarative

    The SqlAlchemy declarative implementation of the web framework

    dev

    The development tools

    doc

    Documentation and examples

    sqlite

    Support for sqlite databases

    postgresql

    Support for postgresql databases

    mysql

    Support for MySQL databases

    Note

    You need pip > 6 (for wheel support) on Windows.

Previous topic

Web framework tutorial

Next topic

Developing using Reahl in Docker

Navigation

Created using Sphinx 4.0.2.