Merge branch 'main' into feature/save-nx-xx-flags

Author: abrookins

.gitignore

@@ -134,7 +134,13 @@ dmypy.json
 .install.stamp
 
 # Sync version of the library, via Unasync
-redis_om/
+# Note: redis_om/ contains placeholder files that ARE tracked:
+# - README.md (documentation)
+# - __init__.py (so Poetry recognizes it as a package)
+# All other files in redis_om/ are generated by `make sync` and ignored.
+redis_om/*
+!redis_om/README.md
+!redis_om/__init__.py
 tests_sync/
 
 # Apple Files

CONTRIBUTING.md

@@ -330,9 +330,9 @@ For feature requests, please describe:
 
 ## Additional Resources
 
-- [Redis OM Documentation](https://redis.io/docs/stack/get-started/tutorials/stack-python/)
-- [RediSearch Documentation](https://redis.io/docs/stack/search/)
-- [RedisJSON Documentation](https://redis.io/docs/stack/json/)
+- [Redis OM Documentation](https://redis.io/docs/latest/develop/clients/redis-py/)
+- [RediSearch Documentation](https://redis.io/docs/latest/develop/interact/search-and-query/)
+- [RedisJSON Documentation](https://redis.io/docs/latest/develop/data-types/json/)
 - [Pydantic Documentation](https://docs.pydantic.dev/)
 
 ## Getting Help

README.md

@@ -80,7 +80,7 @@ Before writing any code you'll need a Redis instance with the appropriate Redis
 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.
+This launches the [redis-stack](https://redis.io/docs/latest/) 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
@@ -424,8 +424,8 @@ Redis OM uses the [MIT license][license-url].
 [redis-om-js]: https://github.com/redis-om/redis-om-js
 [redis-om-dotnet]: https://github.com/redis-om/redis-om-dotnet
 [redis-om-spring]: https://github.com/redis-om/redis-om-spring
-[redisearch-url]: https://redis.io/docs/stack/search/
-[redis-json-url]: https://redis.io/docs/stack/json/
+[redisearch-url]: https://redis.io/docs/latest/develop/interact/search-and-query/
+[redis-json-url]: https://redis.io/docs/latest/develop/data-types/json/
 [pydantic-url]: https://github.com/samuelcolvin/pydantic
 [ulid-url]: https://github.com/ulid/spec
 [redis-enterprise-url]: https://redis.com/try-free/

aredis_om/model/token_escaper.py

@@ -8,7 +8,7 @@ class TokenEscaper:
     """
 
     # Characters that RediSearch requires us to escape during queries.
-    # Source: https://redis.io/docs/stack/search/reference/escaping/#the-rules-of-text-field-tokenization
+    # Source: https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/escaping/
     DEFAULT_ESCAPED_CHARS = r"[,.<>{}\[\]\\\"\':;!@#$%^&*()\-+=~\/ ]"
 
     def __init__(self, escape_chars_re: Optional[Pattern[str]] = None):

docs/getting_started.md

@@ -765,6 +765,6 @@ If you're a FastAPI user, check out [how to integrate Redis OM with FastAPI](htt
 
 <!-- Links -->
 
-[redisearch-url]: https://redis.io/docs/stack/search/
-[redis-json-url]: https://redis.io/docs/stack/json/
+[redisearch-url]: https://redis.io/docs/latest/develop/interact/search-and-query/
+[redis-json-url]: https://redis.io/docs/latest/develop/data-types/json/
 [pydantic-url]: https://github.com/samuelcolvin/pydantic

docs/redis_modules.md

@@ -22,8 +22,8 @@ So, what won't work without these modules?
 
 You can use RediSearch and RedisJSON with your self-hosted Redis deployment. Just follow the instructions on installing the binary versions of the modules in their Quick Start Guides:
 
-- [RedisJSON Quick Start - Running Binaries](https://redis.io/docs/stack/json/)
-- [RediSearch Quick Start - Running Binaries](https://redis.io/docs/stack/search/quick_start/)
+- [RedisJSON Quick Start - Running Binaries](https://redis.io/docs/latest/develop/data-types/json/)
+- [RediSearch Quick Start - Running Binaries](https://redis.io/docs/latest/develop/get-started/document-database/)
 
 **NOTE**: Both of these modules' Quick Start Guides also have instructions on how to run the modules in Redis with Docker.
 

make_sync.py

@@ -1,9 +1,13 @@
 import os
 import re
+import shutil
 from pathlib import Path
 
 import unasync
 
+# Files to preserve in redis_om/ directory (not overwritten by sync)
+PRESERVED_FILES = {"README.md"}
+
 ADDITIONAL_REPLACEMENTS = {
     "aredis_om": "redis_om",
     "async_redis": "sync_redis",
@@ -14,7 +18,28 @@
 }
 
 
+def clean_generated_dir(dirpath: Path, preserved: set):
+    """Remove generated files from a directory while preserving specified files."""
+    if not dirpath.exists():
+        return
+    for item in dirpath.iterdir():
+        if item.name in preserved:
+            continue
+        if item.is_dir():
+            shutil.rmtree(item)
+        else:
+            item.unlink()
+
+
 def main():
+    base_dir = Path(__file__).absolute().parent
+
+    # Clean generated directories before regenerating (preserve README.md)
+    redis_om_dir = base_dir / "redis_om"
+    tests_sync_dir = base_dir / "tests_sync"
+    clean_generated_dir(redis_om_dir, PRESERVED_FILES)
+    clean_generated_dir(tests_sync_dir, set())
+
     rules = [
         unasync.Rule(
             fromdir="/aredis_om/",
@@ -28,7 +53,7 @@ def main():
         ),
     ]
     filepaths = []
-    for root, _, filenames in os.walk(Path(__file__).absolute().parent):
+    for root, _, filenames in os.walk(base_dir):
         for filename in filenames:
             if filename.rpartition(".")[-1] in (
                 "py",

pyproject.toml

@@ -9,6 +9,7 @@ readme = "README.md"
 repository = "https://github.com/redis/redis-om-python"
 packages = [
     { "include" = "aredis_om" },
+    { "include" = "redis_om" },
 ]
 classifiers = [
     "Development Status :: 3 - Alpha",
@@ -25,10 +26,10 @@ classifiers = [
     'Programming Language :: Python :: 3.13',
     'Programming Language :: Python',
 ]
-include=[
-    "docs/*",
-    "images/*",
-    "redis_om/**/*",
+# Include redis_om (generated by make sync) in wheel builds.
+# This overrides .gitignore which excludes these files from version control.
+include = [
+    { path = "redis_om/**/*", format = ["sdist", "wheel"] },
 ]
 
 [tool.poetry.urls]

redis_om/README.md

@@ -0,0 +1,20 @@
+# redis_om - Sync Version (Auto-Generated)
+
+This directory contains the **synchronous version** of redis-om-python.
+
+## Important Notes
+
+1. **Do not edit files in this directory directly** - they are auto-generated from `aredis_om/` using [unasync](https://github.com/python-trio/unasync).
+
+2. **To regenerate**: Run `make sync` from the project root.
+
+3. **Why this README exists**: This placeholder file allows the `redis_om` package to be declared in `pyproject.toml` for Poetry 2.0+ compatibility, which requires package directories to exist at install time.
+
+4. **All other files are gitignored**: Only this README is tracked in git. The actual Python files are generated and ignored.
+
+## Development Workflow
+
+1. Make changes in `aredis_om/` (the async version)
+2. Run `make sync` to generate the sync version
+3. Run tests for both versions
+

redis_om/__init__.py

@@ -0,0 +1,5 @@
+# Placeholder __init__.py for Poetry package recognition.
+# This file is overwritten by `make sync` - see redis_om/README.md for details.
+#
+# The actual exports are generated from aredis_om/__init__.py.
+# Run `make sync` to generate the full sync version of the library.