Skip to content

Commit

Permalink
Document extra install options
Browse files Browse the repository at this point in the history
  • Loading branch information
moznuy committed May 7, 2022
1 parent 76ff577 commit bfdd2ef
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
9 changes: 9 additions & 0 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit bfdd2ef

Please sign in to comment.