From 834d959b11331a3777ac828bb9ebe0ffa0fa666a Mon Sep 17 00:00:00 2001 From: Igor Ilic <30923996+dexters1@users.noreply.github.com> Date: Mon, 26 May 2025 15:47:57 +0200 Subject: [PATCH] Readme local install (#872) ## Description Add info about installing Cognee locally ## 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. --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e78735f58..832ffaa3a 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Build dynamic Agent memory using scalable, modular ECL (Extract, Cognify, Load) pipelines. -More on [use-cases](https://docs.cognee.ai/use-cases) and [evals](https://github.com/topoteretes/cognee/tree/main/evals) +More on [use-cases](https://docs.cognee.ai/use-cases) and [evals](https://github.com/topoteretes/cognee/tree/main/evals)
๐ Available Languages @@ -41,7 +41,7 @@ More on [use-cases](https://docs.cognee.ai/use-cases) and [evals](https://github ยท ๐ท๐บ ะ ัััะบะธะน
- +
@@ -73,7 +73,7 @@ Your contributions are at the core of making this a true open source project. An
## ๐ฆ Installation
-You can install Cognee using either **pip**, **poetry**, **uv** or any other python package manager.
+You can install Cognee using either **pip**, **poetry**, **uv** or any other python package manager.
Cognee supports Python 3.8 to 3.12
### With pip
@@ -82,6 +82,17 @@ Cognee supports Python 3.8 to 3.12
pip install cognee
```
+## Local Cognee installation
+
+You can install the local Cognee repo using **pip**, **poetry** and **uv**.
+For local pip installation please make sure your pip version is above version 21.3.
+
+### with UV with all optional dependencies
+
+```bash
+uv sync --all-extras
+```
+
## ๐ป Basic Usage
### Setup
@@ -127,12 +138,12 @@ if __name__ == '__main__':
Example output:
```
Natural Language Processing (NLP) is a cross-disciplinary and interdisciplinary field that involves computer science and information retrieval. It focuses on the interaction between computers and human language, enabling machines to understand and process natural language.
-
+
```
### cognee UI
-You can also cognify your files and query using cognee UI.
+You can also cognify your files and query using cognee UI.
@@ -175,4 +186,3 @@ We are committed to making open source an enjoyable and respectful experience fo
## Star History
[](https://star-history.com/#topoteretes/cognee&Date)
-