<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [💡 Why Redis OM?](#-why-redis-om)
- [💻 Installation](#-installation)
- [🏁 Getting started](#-getting-started)
- [📇 Modeling Your Data](#-modeling-your-data)
- [✓ Validating Data With Your Model](#-validating-data-with-your-model)
- [🔎 Rich Queries and Embedded Models](#-rich-queries-and-embedded-models)
- [Querying](#querying)
- [Embedded Models](#embedded-models)
- [Calling Other Redis Commands](#calling-other-redis-commands)
- [💻 Installation](#-installation)
- [📚 Documentation](#-documentation)
- [⛏️ Troubleshooting](#️-troubleshooting)
- [✨ So How Do You Get RediSearch and RedisJSON?](#-so-how-do-you-get-redisearch-and-redisjson)
@ -57,6 +58,31 @@ This **preview** release contains the following features:
* Declarative secondary-index generation
* Fluent APIs for querying Redis
## 💻 Installation
Installation is simple with `pip`, Poetry, or Pipenv.
```sh
# With pip
$ pip install redis-om
# Or, using Poetry
$ poetry add redis-om
```
## 🏁 Getting started
### Starting Redis
Before writing any code you'll need a Redis instance with the appropriate Redis modules! The quickest way to get this is with Docker:
```sh
docker run -p 6379:6379 -p 8001:8001 redis/redis-stack
```
This launches the [redis-stack](https://redis.io/docs/stack/) an extension of Redis that adds all manner of modern data structures to Redis. You'll also notice that if you open up http://localhost:8001 you'll have access to the redis-insight GUI, a GUI you can use to visualize and work with your data in Redis.
## 📇 Modeling Your Data
Redis OM contains powerful declarative models that give you data validation, serialization, and persistence to Redis.