feat(jans-cedarling): remove wheel dependency from sidecar by SafinWasi · Pull Request #14125 · JanssenProject/jans (original) (raw)
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info ⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 000b4f3c-deed-4e6b-84af-c7f69468c292
📥 Commits
Reviewing files that changed from the base of the PR and between 8319192 and 8afcf22.
📒 Files selected for processing (1)
docs/cedarling/developer/sidecar/cedarling-sidecar-tutorial.md
📝 Walkthrough
Walkthrough
Adds cedarling-python>=0.0.4, refactors the flask-sidecar Docker build to use uv sync and remove wheel-copy/install steps, and updates documentation/tutorials to use Python 3.11 + uv sync and direct flask run instead of manual wheel installs or Poetry-run commands.
Changes
Cedarling Python PyPI Migration
| Layer / File(s) | Summary |
|---|---|
| Declare PyPI dependency and document package availability jans-cedarling/flask-sidecar/pyproject.toml, docs/cedarling/tutorials/python.md | Adds cedarling-python>=0.0.4 to dependencies. Installation docs now reference the cedarling-python PyPI package and update Poetry integration options. |
| Refactor Docker build to use uv sync and remove wheel artifacts jans-cedarling/flask-sidecar/Dockerfile | Stage 1 header renamed to "Dependencies". Stage 2 runs uv sync (including test group), removes wheel copy/install steps, cleans Python bytecode caches, and consolidates ENV including HOME and APP_MODE. |
| Update tutorials and README to reflect PyPI/uv workflow docs/cedarling/developer/sidecar/cedarling-sidecar-tutorial.md, jans-cedarling/flask-sidecar/README.md | Prereqs now require Python 3.11 and uv when not using Docker. Replaces Poetry+wheel bootstrap with uv sync --locked and source .venv/bin/activate; switches startup command to flask run and removes manual wheel install steps from the README. |
Estimated code review effort
🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
- JanssenProject/jans#13944: Also refactors
jans-cedarling/flask-sidecarto useuv-driven syncing and updates build behavior. - JanssenProject/jans#13194: Related changes targeting Python 3.11 and sidecar dependency/build configuration.
Suggested reviewers
- ossdhaval
- moabu
- iromli 🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Description check | ⚠️ Warning | The PR description lacks the required Implementation Details section content and incorrectly marks 'Test and Document the changes' as N/A instead of providing details. | Add a brief explanation of implementation approach under 'Implementation Details' and complete the test/documentation checklist or provide reasoning for N/A marking. |
✅ Passed checks (4 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | ✅ Passed | The title accurately summarizes the main change: removing the wheel dependency and moving the sidecar to use the PyPI package instead. |
| Linked Issues check | ✅ Passed | All code changes align with the objectives in issue #14124: the pyproject.toml adds the PyPI package dependency, Dockerfile and README remove wheel download steps, and documentation is updated to reflect PyPI availability. |
| Out of Scope Changes check | ✅ Passed | All changes are scoped to the stated objectives: updating Flask-sidecar to use the PyPI cedarling_python package and related documentation updates, with no unrelated modifications present. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches 🧪 Generate unit tests (beta)
- Create PR with unit tests
- Commit unit tests in branch
feat-jans-cedarling-14124
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
❤️ Share
Comment @coderabbitai help to get the list of available commands and usage tips.