Switch from Poetry to UV for dependency management (#781)

* Update docs to Material theme and 1.0 compatibility

- Switch to Material for MkDocs theme with Redis branding
- Combine connections.md and redis_modules.md into redis_setup.md
- Recommend Redis 8 over Redis Stack
- Update all code examples for 1.0:
  - Add model-level index=True to indexed models
  - Update Pydantic validators to v2 syntax
  - Update error message formats to Pydantic v2 style
  - Replace @app.on_event with lifespan pattern in FastAPI examples
  - Replace Migrator().run() with om migrate CLI reference

* Link to hosted documentation site in README

* Add RedisInsight to spellcheck wordlist

* Switch from Poetry to UV for dependency management

- Convert pyproject.toml to PEP 621 format with hatchling backend
- Update Makefile to use uv commands
- Update CI, PyPI publish, and docs workflows for UV
- Update documentation references to UV
- Add example apps (FastAPI, Flask) demonstrating all Redis OM features
- Add tests for example app patterns
- Add uv.lock, remove poetry.lock reference from pre-commit

* Fix spellcheck and NaN injection vulnerability

- Add 'uv' to spellcheck wordlist
- Add safe_float() helper to reject NaN/Inf values in Flask app

* Use controlled error payloads instead of raw exception strings

Author: abrookins

.github/wordlist.txt

@@ -110,4 +110,5 @@ issubclass
 ulid
 coroutine
 compat
-programmatically
+programmatically
+uv

.github/workflows/ci.yml

@@ -27,44 +27,16 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
       - name: Setup Python 3.10
         uses: actions/setup-python@v6
         with:
           python-version: ${{env.pythonversion}}
-        #----------------------------------------------
-        #  -----  install & configure poetry  -----
-        #----------------------------------------------
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          installer-parallel: true
-        #----------------------------------------------
-        #       load cached venv if cache exists
-        #----------------------------------------------
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v5
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ env.pythonversion }}-${{ hashFiles('**/poetry.lock') }}
+      - name: Install dependencies
+        run: uv sync
       - name: Make sync version of library (redis_om)
         run: make sync
-        #----------------------------------------------
-        # install dependencies if cache does not exist
-        #----------------------------------------------
-      - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
-        #----------------------------------------------
-        # install your root project, if required
-        #----------------------------------------------
-      - name: Install library
-        run: poetry install --no-interaction
-        #----------------------------------------------
-        #              run test suite
-        #----------------------------------------------
       - name: Run linter
         run: |
           make dist
@@ -99,50 +71,22 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
       - name: Setup Python ${{ matrix.pyver }}
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.pyver }}
-        #----------------------------------------------
-        #  -----  install & configure poetry  -----
-        #----------------------------------------------
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          installer-parallel: true
-        #----------------------------------------------
-        #       load cached venv if cache exists
-        #----------------------------------------------
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v5
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ matrix.pyver }}-${{ hashFiles('**/poetry.lock') }}
-        #----------------------------------------------
-        # Make sync version of library (redis_om)
-        #----------------------------------------------
+      - name: Install dependencies
+        run: uv sync
       - name: Make sync version of library (redis_om)
         run: make sync
-        #----------------------------------------------
-        # install dependencies if cache does not exist
-        #----------------------------------------------
-      - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
-        #----------------------------------------------
-        # install your root project, if required
-        #----------------------------------------------
-      - name: Install library
-        run: poetry install --no-interaction
       - name: Run unittests (redisstack:${{ matrix.redisstack }}, ${{ matrix.os }})
         env:
           REDIS_OM_URL: "redis://localhost:6379?decode_responses=True"
         run: |
           make test
-          poetry run coverage xml
+          uv run coverage xml
       - name: Upload coverage
         uses: codecov/codecov-action@v5
         with:

.github/workflows/docs-pages.yml

@@ -22,34 +22,19 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
           python-version: "3.11"
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          installer-parallel: true
-
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v5
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
-
       - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
-
-      - name: Install library
-        run: poetry install --no-interaction
+        run: uv sync
 
       - name: Build MkDocs site
-        run: poetry run mkdocs build
+        run: uv run mkdocs build
 
       - name: Setup Pages
         uses: actions/configure-pages@v5

.github/workflows/pypi-publish.yaml

@@ -4,56 +4,45 @@ on:
     types: [ published ]
 
 jobs:
-  pytest:
+  publish:
     name: Publish to PyPi
     runs-on: ubuntu-latest
-    env:
-      ACTIONS_ALLOW_UNSECURE_COMMANDS: true
+    environment: release
+    permissions:
+      id-token: write
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v6
 
-      - name: get version from tag
+      - name: Get version from tag
         id: get_version
         run: |
           realversion="${GITHUB_REF/refs\/tags\//}"
           realversion="${realversion//v/}"
-          echo "::set-output name=VERSION::$realversion"
+          echo "VERSION=$realversion" >> $GITHUB_OUTPUT
 
       - name: Set the version for publishing
         uses: sandstromviktor/toml-editor@2.0.0
         with:
           file: "pyproject.toml"
-          key: "tool.poetry.version"
+          key: "project.version"
           value: "${{ steps.get_version.outputs.VERSION }}"
 
-      - name: Set up Python 3.9
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: 3.9
+          python-version: "3.11"
 
-      - name: Cache Poetry virtualenv
-        uses: actions/cache@v5
-        id: cache
-        with:
-          path: ~/.virtualenvs
-          key: poetry-${{ hashFiles('**/poetry.lock') }}
-          restore-keys: |
-            poetry-${{ hashFiles('**/poetry.lock') }}
-
-      - name: Set Poetry config
-        run: |
-          pip install --upgrade pip poetry==1.8.4
-          poetry config virtualenvs.in-project false
-          poetry config virtualenvs.path ~/.virtualenvs
-          poetry export --dev --without-hashes -o requirements.txt
-          pip install -r requirements.txt
+      - name: Install dependencies
+        run: uv sync
 
       - name: Make sync version of library (redis_om)
         run: make sync
 
-      - name: Install
-        run: poetry install --no-interaction
+      - name: Build package
+        run: uv build
 
       - name: Publish to PyPI
-        run: |
-          poetry publish -u __token__ -p ${{ secrets.PYPI_TOKEN }} --build
+        uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml

@@ -4,4 +4,4 @@ repos:
     hooks:
       - id: codespell
         args: [--write-changes]
-        exclude: ^(poetry\.lock|\.git/|docs/.*\.md)$
+        exclude: ^(uv\.lock|\.git/|docs/.*\.md)$

AGENTS.md

@@ -10,8 +10,8 @@ Redis OM Python is an object mapping library for Redis that provides high-level
 
 ### Setup and Installation
 ```bash
-# Install dependencies using Poetry (preferred)
-poetry install
+# Install dependencies using uv (preferred)
+uv sync
 
 # Or directly with pip
 pip install -e .
@@ -177,7 +177,7 @@ class Address(EmbeddedJsonModel):
 
 - **docs/**: Comprehensive documentation in Markdown
 - **docker-compose.yml**: Redis Stack and OSS Redis instances for testing
-- **pyproject.toml**: Poetry configuration with CLI script definitions
+- **pyproject.toml**: Project configuration with CLI script definitions
 - **.github/**: CI/CD workflows and issue templates
 - **Session.vim**: Vim session configuration for development
 

CONTRIBUTING.md

@@ -25,8 +25,8 @@ Redis OM Python is an object mapping library for Redis that provides declarative
 
 ### Prerequisites
 
-- Python 3.8 or higher (we test on 3.8-3.13)
-- [Poetry](https://python-poetry.org/docs/#installation) for dependency management
+- Python 3.10 or higher (we test on 3.10-3.13)
+- [uv](https://docs.astral.sh/uv/) for dependency management
 - Docker and Docker Compose for running Redis
 - Make (for running development commands)
 
@@ -45,7 +45,7 @@ Redis OM Python is an object mapping library for Redis that provides declarative
    make install
    ```
 
-   This will use Poetry to install all dependencies in a virtual environment.
+   This will use uv to install all dependencies in a virtual environment.
 
 3. **Start Redis containers:**
 
@@ -57,12 +57,6 @@ Redis OM Python is an object mapping library for Redis that provides declarative
    - Redis Stack (port 6380) - includes RediSearch and RedisJSON modules
    - Redis OSS (port 6381) - standard Redis for compatibility testing
 
-4. **Enter the Poetry shell (optional):**
-
-   ```bash
-   make shell
-   ```
-
 ## Project Architecture
 
 ### � Critical: Dual Async/Sync Architecture
@@ -145,7 +139,7 @@ make sync
 vim tests/test_your_feature.py
 
 # 5. Run tests iteratively
-poetry run pytest tests/test_your_feature.py -vv
+uv run pytest tests/test_your_feature.py -vv
 
 # 6. Format and lint
 make format
@@ -164,16 +158,16 @@ make test
 make test
 
 # Run specific test file
-poetry run pytest tests/test_hash_model.py -vv
+uv run pytest tests/test_hash_model.py -vv
 
 # Run specific test
-poetry run pytest tests/test_hash_model.py::test_saves_model -vv
+uv run pytest tests/test_hash_model.py::test_saves_model -vv
 
 # Run with coverage
-poetry run pytest --cov=aredis_om --cov=redis_om --cov-report=term-missing
+uv run pytest --cov=aredis_om --cov=redis_om --cov-report=term-missing
 
 # Run tests in parallel
-poetry run pytest -n auto
+uv run pytest -n auto
 
 # Test against OSS Redis (without modules)
 make test_oss