Skip to content
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

docs: Fix postgres install instruction #182

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Conversation

dexters1
Copy link
Collaborator

@dexters1 dexters1 commented Nov 8, 2024

Fix instruction on how to install postgres

Docs

Summary by CodeRabbit

  • Documentation
    • Added new installation instructions for PostgreSQL support using pip and poetry.
      • New command for pip: pip install 'cognee[postgres]'
      • New command for poetry: poetry add cognee -E postgres

Fix instruction on how to install postgres

Docs
Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

Walkthrough

The changes in this pull request involve updates to the README.md file, specifically adding new installation instructions for PostgreSQL support. Two new commands are introduced for users: one for installation using pip and another for poetry. The overall structure of the document remains unchanged, with no modifications made to existing content.

Changes

File Change Summary
README.md Added installation instructions for PostgreSQL support with pip and poetry. New commands: pip install 'cognee[postgres]' and poetry add cognee -E postgres.

Possibly related PRs

  • Cog 457 update postgres docs #172: The changes in this PR also add installation instructions for PostgreSQL support in the README.md, directly relating to the main PR's focus on enhancing PostgreSQL installation guidance.
  • docs: Update README.md to include postgres #179: This PR introduces similar installation commands for PostgreSQL support in the README.md, making it closely related to the changes made in the main PR.

Suggested reviewers

  • Vasilije1990

Poem

In the garden where bunnies play,
New commands have hopped our way!
PostgreSQL, now easy to find,
With pip and poetry, oh so kind!
Install with joy, let coding thrive,
With these updates, our projects come alive! 🐇✨


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dexters1 dexters1 requested a review from Vasilije1990 November 8, 2024 11:31
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

🧹 Outside diff range and nitpick comments (1)
README.md (1)

32-36: Consider adding context about PostgreSQL support.

To help users make informed decisions, consider adding:

  1. Brief explanation of when PostgreSQL support is needed
  2. Link to PostgreSQL configuration requirements
  3. Reference to the existing PostgreSQL setup section (where users need to set DB_PROVIDER=postgres)

Example addition:

 ### With pip with PostgreSQL support
+
+For users requiring PostgreSQL as the vector store backend:
 
 ```bash
 pip install 'cognee[postgres]'

+After installation, follow the PostgreSQL configuration instructions to set up your database.


</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 9d7f58c1f76bd0bfc617369a4fdcb96910e2bf48 and 2ae2b7b98d9d21d92c56a0a083accf703786b69c.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `README.md` (1 hunks)

</details>

<details>
<summary>🔇 Additional comments (1)</summary>

<details>
<summary>README.md (1)</summary>

`32-36`: **LGTM! The PostgreSQL installation command is correct.**

The pip installation command for PostgreSQL support is properly formatted and placed in a logical location within the documentation.

</details>

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@Vasilije1990 Vasilije1990 merged commit 3245d44 into main Nov 8, 2024
23 of 24 checks passed
@Vasilije1990 Vasilije1990 deleted the update-readme-postgres branch November 8, 2024 11:34
This was referenced Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants