Following poetry changes. #526
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe pull request updates the installation instructions in the Changes
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: lint (ubuntu-latest, 3.11.x)
- GitHub Check: lint (ubuntu-latest, 3.10.x)
- GitHub Check: docker-compose-test
🔇 Additional comments (1)
README.md (1)
69-85: Verify and align poetry installation instructions.The "With poetry with specific database support" section uses a different approach (
poetry add cognee -E <database>) compared to the basic installation section. This inconsistency might confuse users.Please clarify:
- Whether users should use
poetry addorpoetry install- How to combine the basic installation steps with database-specific installation
- Whether the shell plugin and virtualenv configuration are required for database-specific installations
🧰 Tools
🪛 LanguageTool
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...nstall Cognee with support for specific databases use the appropriate command below. Repl...(AI_HYDRA_LEO_MISSING_COMMA)
| poetry config virtualenvs.in-project true | ||
| poetry self add poetry-plugin-shell | ||
| poetry install | ||
| poetry shell |
There was a problem hiding this comment.
Add missing step to install cognee package.
The current poetry installation instructions are incomplete. They configure the environment but don't install the cognee package itself. This conflicts with the database-specific installation section below that uses poetry add cognee.
Add the missing step to install cognee:
poetry config virtualenvs.in-project true
poetry self add poetry-plugin-shell
+poetry add cognee
poetry install
poetry shell📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| poetry config virtualenvs.in-project true | |
| poetry self add poetry-plugin-shell | |
| poetry install | |
| poetry shell | |
| poetry config virtualenvs.in-project true | |
| poetry self add poetry-plugin-shell | |
| poetry add cognee | |
| poetry install | |
| poetry shell |
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
| ### With poetry | ||
|
|
||
| ```bash | ||
| poetry add cognee |
There was a problem hiding this comment.
The poetry add command adds Cognee to someones python project and installs them.
The poetry install command reads the pyproject.toml file from the current project ( cognee for example ), resolves the dependencies, and installs them.
Might be good to have both steps differentiated in Readme.md
There was a problem hiding this comment.
Yeah, it would be good to have both, one for installation, other is for local setup of cognee for contribution.
| poetry config virtualenvs.in-project true | ||
| poetry self add poetry-plugin-shell | ||
| poetry install | ||
| poetry shell |
Vasilije1990
deleted the
feature/cog-1287-cognee-poetry-install-fails
branch
|
@Vasilije1990 no, AFAIK you couldn't even do it as you'd be adding a cognee to cognee as a dependency |
Description
Following poetry changes to have a working install script.
DCO Affirmation
I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin
Summary by CodeRabbit