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: Update README.md to include postgres #179

Merged
merged 1 commit into from
Nov 8, 2024

Conversation

dexters1
Copy link
Collaborator

@dexters1 dexters1 commented Nov 7, 2024

Update README.md to include postgres

Docs

Summary by CodeRabbit

  • New Features
    • Added installation instructions for the cognee package with PostgreSQL support in the README.
    • Provided commands for both pip and poetry to simplify the setup process for users requiring database capabilities.

Update README.md to include postgres

Docs
@dexters1 dexters1 requested a review from Vasilije1990 November 7, 2024 19:19
Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Walkthrough

The changes in this pull request introduce a new section in the README.md file, detailing the installation of the cognee package with PostgreSQL support. Two specific installation commands are added: one for pip and another for poetry. This addition aims to facilitate the setup process for users needing PostgreSQL capabilities, while the remainder of the document remains unchanged.

Changes

File Change Summary
README.md Added installation commands for cognee with PostgreSQL support: 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 enhance the README.md by adding installation instructions specifically for PostgreSQL support, which directly relates to the new section added in the main PR for installing the cognee package with PostgreSQL capabilities.

Suggested reviewers

  • Vasilije1990

Poem

In the land of code where rabbits play,
A new command hops in, brightening the day.
With PostgreSQL, we leap and cheer,
Installing cognee, the path is clear!
So grab your tools, let’s code away,
Together we build, come what may! 🐇✨


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.

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: LGTM with a minor suggestion.

The PostgreSQL installation instructions are clear and well-placed. However, consider adding a brief note explaining when users might need the PostgreSQL support (e.g., "Install this version if you plan to use PostgreSQL as your vector store backend").

Apply this diff to enhance clarity:

 ### With pip with PostgreSQL support
-
+
+Install this version if you plan to use PostgreSQL as your vector store backend:
+
 ```bash
 pip install cognee[postgres]

</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 168cb5d1bf1964b5b0c645b2f3d8638d84554fda and 44fe3797570817cb737a931b8041e615fa8ddfd4.

</details>

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

* `README.md` (1 hunks)

</details>

</details>

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

@Vasilije1990 Vasilije1990 merged commit d2387fa into main Nov 8, 2024
23 of 24 checks passed
@Vasilije1990 Vasilije1990 deleted the update-readme-postgres branch November 8, 2024 10:55
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