:orphan:

.. _install:

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

The library is distributed from PyPI and can be installed using :external+pip:doc:`pip <installation>`.

.. code-block:: console

   $ pip install zrq

The package has a single dependency to :external+redis:doc:`redis-py - the official Python Redis client <index>`.
However, it is heavily recommanded to install ZRQ into a :external+python:mod:`virtualenv <venv>`.

.. _install-redis:

Redis Server
------------

Redis can be installed on wide range of plateforms. It comes with good defaults to be runned in standalone mode out of the box.
ZRQ needs at least the release v\ `5.0` which enable the new streaming data structure.

.. warning::
   The methods described below are solely for development purposes on localhost.
   For a production grade setup, you must read the official `Redis security <https://redis.io/docs/latest/operate/oss_and_stack/management/security/>`_ guide.

High availablity with `Redis Sentinel <https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/>`_ and scaling to `Redis Cluster <https://redis.io/docs/latest/operate/oss_and_stack/management/scaling/>`_ are not covered here.

Using Docker
^^^^^^^^^^^^

Using Docker Engine (brought by `Docker Desktop <https://www.docker.com/products/docker-desktop/>`_) are the preferred way to run a Redis instance as it handle the multi-platform support.
To install Docker, you may follow the official `Get Docker Desktop <https://docs.docker.com/guides/getting-started/get-docker-desktop/>`_ guide.

.. code-block:: console

   > Runs a container and bind the default redis port to localhost
   $ docker run --name redis -dp 127.0.0.1:6379:6379 redis:latest

   > Stops the container instance
   $ docker stop redis

   > Starts a previously stopped container
   $ docker start redis

   > Removes a stopped container including his data
   $ docker rm redis

GNU/Linux
^^^^^^^^^

For Debian-like distributions, there is apt.

.. code-block:: console

   $ sudo apt update
   $ sudo apt install redis
   > Starts Redis at background
   $ sudo systemctl start redis 

From Redis docs: `Install Redis on Linux <https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/>`_.

macOS
^^^^^

For macOS, there is brew.

.. code-block:: console

   $ brew update
   $ brew install redis
   > Starts Redis at background
   $ redis-server --bind 127.0.0.1

From Redis docs: `Install Redis on macOS <https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os/>`_.

Windows
^^^^^^^

For Windows, you'll first need to enable WSL2 and use the GNU/Linux apt method.
More details can be found on the Redis documentation: `Install Redis on Windows <https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-windows/>`_.

From Source
^^^^^^^^^^^

You nerd. `Check the guide <https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-from-source/>`_ to build Redis from source.