Skip to content

Clean dependencies #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Document extra install options
  • Loading branch information
moznuy committed May 7, 2022
commit bfdd2ef4cf93e414d2af728631db936557c9b204
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