-
Notifications
You must be signed in to change notification settings - Fork 14
Replace pdm to uv in README #40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
It seems that a couple of references to `pdm` were still present in the README, which I believe is a leftover, since the project is using `uv`.
WalkthroughREADME documentation updated to replace pdm run with uv run in three code blocks: one for embedding model download and two for running the custom processor. No code or interface changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal). Please share your feedback with us on this Discord post. ✨ Finishing touches🧪 Generate unit tests
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
89-92
: Use mkdir -p for idempotency; change looks good.Replacing pdm with uv here is correct. Consider making the directory creation idempotent.
- mkdir ./embeddings_model + mkdir -p ./embeddings_model
216-224
: Run the script via Python for portability and consistency.
uv run ./custom_processor.py
relies on an executable bit and shebang. Using Python mirrors the earlier example and works cross‑platform.-uv run ./custom_processor.py \ +uv run python ./custom_processor.py \
264-272
: Apply the same invocation style here.Align with the Faiss example to avoid shebang/executable assumptions.
-uv run ./custom_processor.py \ +uv run python ./custom_processor.py \
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
It seems that a couple of references to
pdm
were still present in the README, which I believe is a leftover, since the project is usinguv
.Type of change
Related Tickets & Documents
Checklist before requesting a review
Testing
Summary by CodeRabbit