Include redis_om package for Poetry 2.0+ compatibility (#740)

* include redis_om package

* Add redis_om placeholder for Poetry 2.0+ compatibility

- Add redis_om/README.md placeholder so package directory exists
- Update .gitignore to track README.md but ignore generated files
- Update make_sync.py to preserve README.md when regenerating

* Add placeholder __init__.py so Poetry recognizes redis_om as a package

* Fix wheel packaging to include redis_om and exclude docs/images

- Add redis_om to packages AND include with format=[sdist, wheel] to
  override .gitignore exclusion
- Remove docs/* and images/* from include (shouldn't be in wheels)

Fixes all issues from #713:
1. redis_om/ missing from wheel
2. docs/ and images/ incorrectly in wheel
3. python-ulid already updated in prior commit

Closes #713
Closes #731

---------

Co-authored-by: dotlambda <[email protected]>

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

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.