https://github.com/redis-developer/redis-om-python-search-demo
Demo using the Redis OM Python client and RediSearch
https://github.com/redis-developer/redis-om-python-search-demo
Last synced: 7 months ago
JSON representation
Demo using the Redis OM Python client and RediSearch
- Host: GitHub
- URL: https://github.com/redis-developer/redis-om-python-search-demo
- Owner: redis-developer
- License: mit
- Created: 2021-12-09T15:31:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-17T21:58:18.000Z (over 3 years ago)
- Last Synced: 2025-04-12T03:52:58.508Z (11 months ago)
- Language: Python
- Size: 414 KB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redis OM Python Search Demo
This repository contains a basic demonstration of the object modeling and search capabilities of the [Redis OM Python client](https://github.com/redis/redis-om-python) for [Redis](https://redis.io). Watch a video of [Simon](https://simonprickett.dev) presenting this demo on [YouTube](https://youtu.be/DFNKmbGKa5w?t=410) at a Redis Montly Live event (check out the [Redis Developer Relations team events page](https://developer.redis.com/redis-live/) for our upcoming events).
The demo requires you to have [RediSearch](https://oss.redis.com/redisearch/) 2.2 or higher installed on your Redis server. The easiest way to try this demo is by following the GitPod instructions below - this will run the demo entirely in a free cloud environent with nothing to install. If you'd prefer to install Redis + RediSearch locally instead, use the supplied `docker-compose.yml` file, so you'll want to have [Docker Desktop](https://www.docker.com/get-started) installed. This uses the [Redis Stack](https://hub.docker.com/r/redis/redis-stack) container, which gives you Redis plus the RediSearch and other modules pre-installed.
To run locally, you'll also require a reasonably up to date version of Python 3 - 3.8 or better. I've tested this on the following version of Python on macOS Monterey 12.5.1:
```bash
$ python3 --version
Python 3.9.5
```
## Overview
We'll take a look at how to model domain objects in Python using Redis OM. You'll find the model in `adoptable.py`. These objects can then be persisted to [Redis Hashes](https://www.youtube.com/watch?v=-KdITaRkQ-U) by calling `save()` on them. By defining which fields should be indexed and how to index them, we can tell Redis OM to build and maintain a RediSearch index for us. This allows us to leverage the fluent querying API to retrieve objects matching multiple search criteria.
In this example, we'll use a small data set of dogs and cats that are available for adoption at an animal shelter. This data is in the file `animal_data.csv`.
## Run this Demo Entirely in the Cloud with GitPod
When using [Gitpod](https://gitpod.io), the only things you need are:
* A modern browser (we have tested with [Google Chrome](https://www.google.com/chrome/)).
* A [GitHub](https://github.com) account.
Click the button below to start a new cloud development environment using Gitpod:
[](https://gitpod.io/#https://github.com/redis-developer/redis-om-python-search-demo)
If you're using Gitpod for the first time, you'll need to authorize it to work with your GitHub account.
Gitpod will then open a workspace in the browser for you. This contains:
* VS Code for viewing and editing the code.
* An embedded browser window with the [RedisInsight](https://redis.com/redis-enterprise/redis-insight/) database visualization tool running in it.
* A terminal session -- this is where you'll run the Python scripts to load the sample data and query it. Note that this terminal will only become available once you have agreed to the terms and conditions to use RedisInsight in the browser window.
Your environment should look something like this:
## Local Setup
(Skip this section if you're using a GitPod hosted environment)
To try the code out, you'll want to clone the repo, create a Python virtual environment, install dependencies and start Redis using Docker:
```bash
$ git clone https://github.com/redis-developer/redis-om-python-search-demo.git
$ cd redis-om-python-search-demo
$ python3 -m venv venv
$ . ./venv/bin/activate
$ pip install -r requirements.txt
```
Then, start the Redis Stack container:
```bash
$ docker-compose up -d
```
## Loading the Data into Redis and Indexing it
Now it's time to load the data into Redis and setup the RediSearch index:
```bash
$ python load_adoptables.py
```
You should see output showing the name and Redis key of each animal loaded from `animal_data.csv`.
## Running the Code
To query the data, run `query_adoptables.py`:
```bash
$ python query_adoptables.py
```
You can change which query runs by editing the final four lines of `query_adoptables.py` to add/remove comments as needed.
The example queries are as follows:
* `find_by_name`: Find all animals whose `name` field is `Luna`
* `find_male_dogs`: Find all animals where `sex` is `m` and `species` is `dog`
* `find_dogs_in_age_range`: Find all animals where `species` is `dog` and `age` is 9 or 10
* `find_cats_good_with_children`: Final all animals where `species` is `cat` and `children` (good with children) is `y` and where the free text `description` field does not contain `anxious` or `nervous` but does contain words similar to `play` e.g. `play`, `playful`
## Shutting Down (when running locally)
When you're done with the demo, shut down the Redis server:
```bash
$ cd redis-om-python-search-demo
$ docker-compose down
```