gmakstutis/cognee
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Readme local install (#872)

Browse source 
<!-- .github/pull_request_template.md -->

## 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.
This commit is contained in:
Igor Ilic 2025-05-26 15:47:57 +02:00 • committed by GitHub
parent 4650c9c638
commit 834d959b11
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -30,7 +30,7 @@
Build dynamic Agent memory using scalable, modular ECL (Extract, Cognify, Load) pipelines. 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)
<p align="center"> <p align="center">
🌐 Available Languages 🌐 Available Languages
@ -41,7 +41,7 @@ More on [use-cases](https://docs.cognee.ai/use-cases) and [evals](https://github
· ·
<a href="assets/community/README.ru.md">🇷🇺 Русский</a> <a href="assets/community/README.ru.md">🇷🇺 Русский</a>
</p> </p>
<div style="text-align: center"> <div style="text-align: center">
<img src="https://raw.githubusercontent.com/topoteretes/cognee/refs/heads/main/assets/cognee_benefits.png" alt="Why cognee?" width="50%" /> <img src="https://raw.githubusercontent.com/topoteretes/cognee/refs/heads/main/assets/cognee_benefits.png" alt="Why cognee?" width="50%" />
@ -73,7 +73,7 @@ Your contributions are at the core of making this a true open source project. An
## 📦 Installation ## 📦 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 Cognee supports Python 3.8 to 3.12
### With pip ### With pip
@ -82,6 +82,17 @@ Cognee supports Python 3.8 to 3.12
pip install cognee 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 ## 💻 Basic Usage
### Setup ### Setup
@ -127,12 +138,12 @@ if __name__ == '__main__':
Example output: 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. 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 ### cognee UI
You can also cognify your files and query using cognee UI. You can also cognify your files and query using cognee UI.
<img src="assets/cognee-ui-2.webp" width="100%" alt="Cognee UI 2"></a> <img src="assets/cognee-ui-2.webp" width="100%" alt="Cognee UI 2"></a>
@ -175,4 +186,3 @@ We are committed to making open source an enjoyable and respectful experience fo
## Star History ## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=topoteretes/cognee&type=Date)](https://star-history.com/#topoteretes/cognee&Date) [![Star History Chart](https://api.star-history.com/svg?repos=topoteretes/cognee&type=Date)](https://star-history.com/#topoteretes/cognee&Date)