From bfdd2ef4cf93e414d2af728631db936557c9b204 Mon Sep 17 00:00:00 2001 From: Serhii Charykov Date: Fri, 6 May 2022 19:38:21 +0300 Subject: [PATCH] Document extra install options --- README.md | 6 ++++++ docs/getting_started.md | 9 +++++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index e8637de1..7a5b5bba 100644 --- a/README.md +++ b/README.md @@ -334,6 +334,12 @@ Installation is simple with `pip`, Poetry, or Pipenv. # With pip $ pip install redis-om +# Optionally hiredis can be installed separately or with +$ pip install redis-om[hiredis] + +# If you intend to use pydantic.EmailStr for email validation you need to install email-validator separately or with +$ pip install redis-om[email] + # Or, using Poetry $ poetry add redis-om ``` diff --git a/docs/getting_started.md b/docs/getting_started.md index 6e81854f..a9a0779a 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -105,6 +105,15 @@ Finally, you can install Redis OM with `pip` by running the following command: **TIP:** If you aren't using Poetry or Pipenv and are instead installing directly with `pip`, we recommend that you install Redis OM in a virtual environment (AKA, a virtualenv). If you aren't familiar with this concept, see [Dan Bader's video and transcript](https://realpython.com/lessons/creating-virtual-environment/). +Optionally hiredis can be installed separately or with + + $ pip install redis-om[hiredis] + +If you intend to use pydantic.EmailStr for email validation you need to install email-validator separately or with + + $ pip install redis-om[email] + + ## Setting the Redis URL Environment Variable