Skip to content

Commit fa955da

Browse files
committed
Document extra install options
1 parent 1265aff commit fa955da

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,12 @@ Installation is simple with `pip`, Poetry, or Pipenv.
334334
# With pip
335335
$ pip install redis-om
336336

337+
# Optionally hiredis can be installed separately or with
338+
$ pip install redis-om[hiredis]
339+
340+
# If you intend to use pydantic.EmailStr for email validation you need to install email-validator separately or with
341+
$ pip install redis-om[email]
342+
337343
# Or, using Poetry
338344
$ poetry add redis-om
339345
```

docs/getting_started.md

+9
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,15 @@ Finally, you can install Redis OM with `pip` by running the following command:
105105

106106
**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/).
107107

108+
Optionally hiredis can be installed separately or with
109+
110+
$ pip install redis-om[hiredis]
111+
112+
If you intend to use pydantic.EmailStr for email validation you need to install email-validator separately or with
113+
114+
$ pip install redis-om[email]
115+
116+
108117

109118
## Setting the Redis URL Environment Variable
110119

0 commit comments

Comments
 (0)