Getting Started

Dependencies

The quantum-robot package requires Redis, a high performance, super fast and easy to use in-memory database.

To install redis, check redis.io/docs/getting-started/installation/
The redis-py pyhon package is what is used by quantum-robot to connect to the redis database (redis.io/clients#python).

Note

To run the Redis server in Linux use the bash command service redis-server start

It is also possible to use Docker to spin a redis server without installing redis on your local machine:

docker run --name redis_contaner -p 6379:6379 -d redis

The to stop it:

docker stop redis_contaner
docker rm redis_contaner

To check wether the redis database is reachable, open a python shell (e.g. poetry run python) and run:

>>> from qrobot.qunits.redis_utils import redis_status
>>> redis_status()

The easiest way to install quantum-robot is using pip:

pip install -U quantum-robot

The package can be installed from source as well via poetry::

git clone https://github.com/Davidelanz/quantum-robot.git
cd quantum-robot
poetry install