Following poetry changes. #526
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -40,10 +40,20 @@ pip install cognee | |||||||||||||||||||
|
|
||||||||||||||||||||
| ### With poetry | ||||||||||||||||||||
|
|
||||||||||||||||||||
| If adding to you project | ||||||||||||||||||||
| ``` | ||||||||||||||||||||
| poetry add cognee | ||||||||||||||||||||
| ``` | ||||||||||||||||||||
|
|
||||||||||||||||||||
| If installing inside cloned repository | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ```bash | ||||||||||||||||||||
| poetry config virtualenvs.in-project true | ||||||||||||||||||||
| poetry self add poetry-plugin-shell | ||||||||||||||||||||
| poetry install | ||||||||||||||||||||
| poetry shell | ||||||||||||||||||||
|
Comment on lines
+51
to
+54
Contributor
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 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
Suggested change
Contributor
There was a problem hiding this comment.
|
||||||||||||||||||||
| ``` | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ### With pip with specific database support | ||||||||||||||||||||
|
|
||||||||||||||||||||
| To install Cognee with support for specific databases use the appropriate command below. Replace \<database> with the name of the database you need. | ||||||||||||||||||||
|
|
||||||||||||||||||||
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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, it would be good to have both, one for installation, other is for local setup of cognee for contribution.