cognee 0.2.3.dev1__tar.gz → 0.3.0.dev0__tar.gz

cognee-0.3.0.dev0/.env.template

@@ -0,0 +1,238 @@
+###############################################################################
+# NOTE: With default settings Cognee only needs an OpenAI LLM_API_KEY to be set.
+#       The rest of the settings don't have to be set.
+#       Default relational database: SQLite
+#       Default vector database   : LanceDB
+#       Default graph database    : Kuzu
+#
+#       These default databases are all file-based, so no extra setup is needed
+#       for local use. The data by default will be stored in your .venv
+###############################################################################
+
+################################################################################
+#  🧠 LLM Settings
+################################################################################
+# Currently we support BAML and Instructor(using litellm) for structured outputs
+STRUCTURED_OUTPUT_FRAMEWORK="instructor"
+
+LLM_API_KEY="your_api_key"
+LLM_MODEL="openai/gpt-4o-mini"
+LLM_PROVIDER="openai"
+LLM_ENDPOINT=""
+LLM_API_VERSION=""
+LLM_MAX_TOKENS="16384"
+
+EMBEDDING_PROVIDER="openai"
+EMBEDDING_MODEL="openai/text-embedding-3-large"
+EMBEDDING_ENDPOINT=""
+EMBEDDING_API_VERSION=""
+EMBEDDING_DIMENSIONS=3072
+EMBEDDING_MAX_TOKENS=8191
+# If embedding key is not provided same key set for LLM_API_KEY will be used
+#EMBEDDING_API_KEY="your_api_key"
+
+# If using BAML structured output these env variables will be used
+BAML_LLM_PROVIDER=openai
+BAML_LLM_MODEL="gpt-4o-mini"
+BAML_LLM_ENDPOINT=""
+BAML_LLM_API_KEY="your_api_key"
+BAML_LLM_API_VERSION=""
+
+
+################################################################################
+#  📂 ROOT DIRECTORY FOR DATABASES
+################################################################################
+# Set up the Cognee system directory. Cognee will store system files and databases here.
+# Useful for setting root directory inside docker and also to avoid storing the databases in .venv
+# DATA_ROOT_DIRECTORY='/Users/<user>/Desktop/cognee/.cognee_data/'
+# SYSTEM_ROOT_DIRECTORY='/Users/<user>/Desktop/cognee/.cognee_system/'
+
+################################################################################
+# 🗄️ Relational database settings
+################################################################################
+
+DB_PROVIDER="sqlite"
+DB_NAME=cognee_db
+
+# -- To switch to Postgres / PGVector, uncomment and fill these: -------------
+#DB_PROVIDER=postgres
+#DB_NAME=cognee_db
+# To use Postgres with the Cognee backend in Docker compose use the following instead: DB_HOST=host.docker.internal
+#DB_HOST=127.0.0.1
+#DB_PORT=5432
+#DB_USERNAME=cognee
+#DB_PASSWORD=cognee
+
+################################################################################
+# 🕸️ Graph Database settings
+################################################################################
+
+# Default (local file-based)
+GRAPH_DATABASE_PROVIDER="kuzu"
+
+# -- To switch to Remote Kuzu uncomment and fill these: -------------------------------------------------------------
+#GRAPH_DATABASE_PROVIDER="kuzu"
+#GRAPH_DATABASE_PROVIDER="kuzu-remote"
+#GRAPH_DATABASE_URL="http://localhost:8000"
+#GRAPH_DATABASE_USERNAME=XXX
+#GRAPH_DATABASE_PASSWORD=YYY
+
+# -- To switch to Neo4j uncomment and fill these: -------------------------------------------------------------------
+#GRAPH_DATABASE_PROVIDER="neo4j"
+#GRAPH_DATABASE_URL=bolt://localhost:7687
+#GRAPH_DATABASE_NAME="neo4j"
+#GRAPH_DATABASE_USERNAME=neo4j
+#GRAPH_DATABASE_PASSWORD=localneo4j
+
+################################################################################
+#  📐 Vector Database settings
+################################################################################
+
+# Supported providers: pgvector | qdrant | weaviate | milvus | lancedb | chromadb
+VECTOR_DB_PROVIDER="lancedb"
+# Not needed if a cloud vector database is not used
+VECTOR_DB_URL=
+VECTOR_DB_KEY=
+
+
+
+################################################################################
+#  🔄  MIGRATION (RELATIONAL → GRAPH) SETTINGS
+################################################################################
+
+MIGRATION_DB_PATH="/path/to/migration/directory"
+MIGRATION_DB_NAME="migration_database.sqlite"
+MIGRATION_DB_PROVIDER="sqlite"
+
+# -- Postgres-specific migration params --------------------------------------
+# MIGRATION_DB_USERNAME=cognee
+# MIGRATION_DB_PASSWORD=cognee
+# MIGRATION_DB_HOST="127.0.0.1"
+# MIGRATION_DB_PORT=5432
+
+################################################################################
+# 🔒 Security Settings
+################################################################################
+
+# When set to false don't allow adding of local system files to Cognee. Should be set to False when Cognee is used as a backend.
+ACCEPT_LOCAL_FILE_PATH=True
+
+# When set to false don't allow HTTP requests to be sent from Cognee.
+# This protects against Server Side Request Forgery when proper infrastructure is not in place.
+ALLOW_HTTP_REQUESTS=True
+
+# When set to False errors during data processing will be returned as info but not raised to allow handling of faulty documents
+RAISE_INCREMENTAL_LOADING_ERRORS=True
+
+# When set to True, the Cognee backend will require authentication for requests to the API.
+# If you're disabling this, make sure to also disable ENABLE_BACKEND_ACCESS_CONTROL.
+REQUIRE_AUTHENTICATION=False
+
+# Set this variable to True to enforce usage of backend access control for Cognee
+# Note: This is only currently supported by the following databases:
+#       Relational: SQLite, Postgres
+#       Vector: LanceDB
+#       Graph: KuzuDB
+#
+# It enforces LanceDB and KuzuDB use and uses them to create databases per Cognee user + dataset
+ENABLE_BACKEND_ACCESS_CONTROL=False
+
+################################################################################
+# ☁️ Cloud Sync Settings
+################################################################################
+
+# Cognee Cloud API settings for syncing data to/from cloud infrastructure
+COGNEE_CLOUD_API_URL="http://localhost:8001"
+COGNEE_CLOUD_AUTH_TOKEN="your-auth-token"
+
+################################################################################
+#  🛠️ DEV Settings
+################################################################################
+
+ENV="local"
+
+TOKENIZERS_PARALLELISM="false"
+
+# LITELLM Logging Level. Set to quiet down logging
+LITELLM_LOG="ERROR"
+
+# Set this environment variable to disable sending telemetry data
+# TELEMETRY_DISABLED=1
+
+# Default User Configuration
+# DEFAULT_USER_EMAIL=""
+# DEFAULT_USER_PASSWORD=""
+
+------------------------------- END OF POSSIBLE SETTINGS -------------------------------
+
+
+###############################################################################
+# 🧪  EXAMPLE OVERRIDES (commented out)
+###############################################################################
+# The blocks below show how to configure alternative providers.
+# Uncomment + fill values to switch.
+
+########## Azure OpenAI #######################################################
+#LLM_MODEL="azure/gpt-5-mini"
+#LLM_ENDPOINT="https://DNS.azure.com/openai/deployments/gpt-5-mini"
+#LLM_API_KEY="<<TALK TO YOUR AZURE GUY"
+#LLM_API_VERSION="2024-12-01-preview"
+
+## llm api version might not be relevant
+#LLM_MAX_TOKENS="16384"
+
+#EMBEDDING_MODEL="azure/text-embedding-3-large"
+#EMBEDDING_ENDPOINT="https://DNS.openai.azure.com/openai/deployments/text-embedding-3-large"
+#EMBEDDING_API_KEY="<<TALK TO YOUR AZURE GUY>"
+#EMBEDDING_API_VERSION="2024-12-01-preview"
+#EMBEDDING_DIMENSIONS=3072
+#EMBEDDING_MAX_TOKENS=8191
+
+########## Local LLM via Ollama ###############################################
+
+#LLM_API_KEY ="ollama"
+#LLM_MODEL="llama3.1:8b"
+#LLM_PROVIDER="ollama"
+#LLM_ENDPOINT="http://localhost:11434/v1"
+#EMBEDDING_PROVIDER="ollama"
+#EMBEDDING_MODEL="avr/sfr-embedding-mistral:latest"
+#EMBEDDING_ENDPOINT="http://localhost:11434/api/embeddings"
+#EMBEDDING_DIMENSIONS=4096
+#HUGGINGFACE_TOKENIZER="Salesforce/SFR-Embedding-Mistral"
+
+########## OpenRouter (also free) #########################################################
+
+#LLM_API_KEY="<<go-get-one-yourself"
+#LLM_PROVIDER="custom"
+#LLM_MODEL="openrouter/google/gemini-2.0-flash-lite-preview-02-05:free"
+#LLM_ENDPOINT="https://openrouter.ai/api/v1"
+
+########## DeepInfra ##########################################################
+
+#LLM_API_KEY="<<>>"
+#LLM_PROVIDER="custom"
+#LLM_MODEL="deepinfra/meta-llama/Meta-Llama-3-8B-Instruct"
+#LLM_ENDPOINT="https://api.deepinfra.com/v1/openai"
+
+#EMBEDDING_PROVIDER="openai"
+#EMBEDDING_API_KEY="<<>>"
+#EMBEDDING_MODEL="deepinfra/BAAI/bge-base-en-v1.5"
+#EMBEDDING_ENDPOINT=""
+#EMBEDDING_API_VERSION=""
+#EMBEDDING_DIMENSIONS=3072
+#EMBEDDING_MAX_TOKENS=8191
+
+
+########## Release Test ###############################################
+
+#LLM_API_KEY="..."
+
+#OPENAI_API_KEY="..."
+
+#MIGRATION_DB_PATH="~/Downloads/"
+#MIGRATION_DB_NAME="Chinook_Sqlite.sqlite"
+#MIGRATION_DB_PROVIDER="sqlite"
+
+#GRAPH_DATABASE_URL="bolt://54.246.89.112:7687"
+#GRAPH_DATABASE_USERNAME="neo4j"
+#GRAPH_DATABASE_PASSWORD="pleaseletmein"

cognee-0.3.0.dev0/PKG-INFO

@@ -0,0 +1,362 @@
+Metadata-Version: 2.4
+Name: cognee
+Version: 0.3.0.dev0
+Summary: Cognee - is a library for enriching LLM context with a semantic layer for better understanding and reasoning.
+Project-URL: Homepage, https://www.cognee.ai
+Project-URL: Repository, https://github.com/topoteretes/cognee
+Author: Vasilije Markovic, Boris Arzentar
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE.md
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: <=3.13,>=3.10
+Requires-Dist: aiofiles<24.0.0,>=23.2.1
+Requires-Dist: aiohttp<4.0.0,>=3.11.14
+Requires-Dist: aiosqlite<1.0.0,>=0.20.0
+Requires-Dist: alembic<2,>=1.13.3
+Requires-Dist: baml-py<0.202.0,>=0.201.0
+Requires-Dist: dlt[sqlalchemy]<2,>=1.9.0
+Requires-Dist: fastapi-users[sqlalchemy]<15.0.0,>=14.0.1
+Requires-Dist: fastapi<1.0.0,>=0.115.7
+Requires-Dist: filetype<2.0.0,>=1.2.0
+Requires-Dist: instructor<2.0.0,>=1.9.1
+Requires-Dist: jinja2<4,>=3.1.3
+Requires-Dist: kuzu==0.11.0
+Requires-Dist: lancedb<1.0.0,>=0.24.0
+Requires-Dist: langfuse<3,>=2.32.0
+Requires-Dist: limits<5,>=4.4.1
+Requires-Dist: litellm<2.0.0,>=1.71.0
+Requires-Dist: matplotlib<4,>=3.8.3
+Requires-Dist: networkx<4,>=3.4.2
+Requires-Dist: nltk<4.0.0,>=3.9.1
+Requires-Dist: numpy<=4.0.0,>=1.26.4
+Requires-Dist: onnxruntime<2.0.0,>=1.0.0
+Requires-Dist: openai<2.0.0,>=1.80.1
+Requires-Dist: pandas<3.0.0,>=2.2.2
+Requires-Dist: pre-commit<5,>=4.0.1
+Requires-Dist: pydantic-settings<3,>=2.2.1
+Requires-Dist: pydantic<3.0.0,>=2.10.5
+Requires-Dist: pylance<1.0.0,>=0.22.0
+Requires-Dist: pympler<2.0.0,>=1.1
+Requires-Dist: pypdf<6.0.0,>=4.1.0
+Requires-Dist: python-dotenv<2.0.0,>=1.0.1
+Requires-Dist: python-magic-bin<0.5; platform_system == 'Windows'
+Requires-Dist: python-multipart<1.0.0,>=0.0.20
+Requires-Dist: rdflib<7.2.0,>=7.1.4
+Requires-Dist: s3fs[boto3]==2025.3.2
+Requires-Dist: scikit-learn<2,>=1.6.1
+Requires-Dist: sentry-sdk[fastapi]<3,>=2.9.0
+Requires-Dist: sqlalchemy<3.0.0,>=2.0.39
+Requires-Dist: structlog<26,>=25.2.0
+Requires-Dist: tiktoken<1.0.0,>=0.8.0
+Requires-Dist: typing-extensions<5.0.0,>=4.12.2
+Provides-Extra: anthropic
+Requires-Dist: anthropic<0.27,>=0.26.1; extra == 'anthropic'
+Provides-Extra: api
+Requires-Dist: gunicorn<24,>=20.1.0; extra == 'api'
+Requires-Dist: uvicorn<1.0.0,>=0.34.0; extra == 'api'
+Requires-Dist: websockets<16.0.0,>=15.0.1; extra == 'api'
+Provides-Extra: aws
+Requires-Dist: s3fs[boto3]==2025.3.2; extra == 'aws'
+Provides-Extra: chromadb
+Requires-Dist: chromadb<0.7,>=0.3.0; extra == 'chromadb'
+Requires-Dist: pypika==0.48.8; extra == 'chromadb'
+Provides-Extra: codegraph
+Requires-Dist: fastembed<=0.6.0; (python_version < '3.13') and extra == 'codegraph'
+Requires-Dist: transformers<5,>=4.46.3; extra == 'codegraph'
+Requires-Dist: tree-sitter-python<0.24,>=0.23.6; extra == 'codegraph'
+Requires-Dist: tree-sitter<0.25,>=0.24.0; extra == 'codegraph'
+Provides-Extra: debug
+Requires-Dist: debugpy<2.0.0,>=1.8.9; extra == 'debug'
+Provides-Extra: deepeval
+Requires-Dist: deepeval<4,>=3.0.1; extra == 'deepeval'
+Provides-Extra: dev
+Requires-Dist: coverage<8,>=7.3.2; extra == 'dev'
+Requires-Dist: deptry<0.21,>=0.20.0; extra == 'dev'
+Requires-Dist: gitpython<4,>=3.1.43; extra == 'dev'
+Requires-Dist: mkdocs-material<10,>=9.5.42; extra == 'dev'
+Requires-Dist: mkdocs-minify-plugin<0.9,>=0.8.0; extra == 'dev'
+Requires-Dist: mkdocstrings[python]<0.27,>=0.26.2; extra == 'dev'
+Requires-Dist: mypy<2,>=1.7.1; extra == 'dev'
+Requires-Dist: notebook<8,>=7.1.0; extra == 'dev'
+Requires-Dist: pylint<4,>=3.0.3; extra == 'dev'
+Requires-Dist: pytest-asyncio<0.22,>=0.21.1; extra == 'dev'
+Requires-Dist: pytest-cov<7.0.0,>=6.1.1; extra == 'dev'
+Requires-Dist: pytest<8,>=7.4.0; extra == 'dev'
+Requires-Dist: ruff<1.0.0,>=0.9.2; extra == 'dev'
+Requires-Dist: tweepy<5.0.0,>=4.14.0; extra == 'dev'
+Provides-Extra: distributed
+Requires-Dist: modal<2.0.0,>=1.0.5; extra == 'distributed'
+Provides-Extra: docs
+Requires-Dist: unstructured[csv,doc,docx,epub,md,odt,org,ppt,pptx,rst,rtf,tsv,xlsx]<19,>=0.18.1; extra == 'docs'
+Provides-Extra: evals
+Requires-Dist: gdown<6,>=5.2.0; extra == 'evals'
+Requires-Dist: plotly<7,>=6.0.0; extra == 'evals'
+Provides-Extra: falkordb
+Requires-Dist: falkordb<2.0.0,>=1.0.9; extra == 'falkordb'
+Provides-Extra: gemini
+Requires-Dist: google-generativeai<0.9,>=0.8.4; extra == 'gemini'
+Provides-Extra: graphiti
+Requires-Dist: graphiti-core<0.8,>=0.7.0; extra == 'graphiti'
+Provides-Extra: groq
+Requires-Dist: groq<1.0.0,>=0.8.0; extra == 'groq'
+Provides-Extra: gui
+Requires-Dist: pyside6<7,>=6.8.3; extra == 'gui'
+Requires-Dist: qasync<0.28,>=0.27.1; extra == 'gui'
+Provides-Extra: huggingface
+Requires-Dist: transformers<5,>=4.46.3; extra == 'huggingface'
+Provides-Extra: langchain
+Requires-Dist: langchain-text-splitters<1.0.0,>=0.3.2; extra == 'langchain'
+Requires-Dist: langsmith<1.0.0,>=0.2.3; extra == 'langchain'
+Provides-Extra: llama-index
+Requires-Dist: llama-index-core<0.13,>=0.12.11; extra == 'llama-index'
+Provides-Extra: mistral
+Requires-Dist: mistral-common<2,>=1.5.2; extra == 'mistral'
+Provides-Extra: neo4j
+Requires-Dist: neo4j<6,>=5.28.0; extra == 'neo4j'
+Provides-Extra: neptune
+Requires-Dist: langchain-aws>=0.2.22; extra == 'neptune'
+Provides-Extra: notebook
+Requires-Dist: notebook<8,>=7.1.0; extra == 'notebook'
+Provides-Extra: ollama
+Requires-Dist: transformers<5,>=4.46.3; extra == 'ollama'
+Provides-Extra: postgres
+Requires-Dist: asyncpg<1.0.0,>=0.30.0; extra == 'postgres'
+Requires-Dist: pgvector<0.4,>=0.3.5; extra == 'postgres'
+Requires-Dist: psycopg2<3,>=2.9.10; extra == 'postgres'
+Provides-Extra: postgres-binary
+Requires-Dist: asyncpg<1.0.0,>=0.30.0; extra == 'postgres-binary'
+Requires-Dist: pgvector<0.4,>=0.3.5; extra == 'postgres-binary'
+Requires-Dist: psycopg2-binary<3.0.0,>=2.9.10; extra == 'postgres-binary'
+Provides-Extra: posthog
+Requires-Dist: posthog<4,>=3.5.0; extra == 'posthog'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <a href="https://github.com/topoteretes/cognee">
+    <img src="https://raw.githubusercontent.com/topoteretes/cognee/refs/heads/dev/assets/cognee-logo-transparent.png" alt="Cognee Logo" height="60">
+  </a>
+
+  <br />
+
+  cognee - Memory for AI Agents in 5 lines of code
+
+  <p align="center">
+  <a href="https://www.youtube.com/watch?v=1bezuvLwJmw&t=2s">Demo</a>
+  .
+  <a href="https://cognee.ai">Learn more</a>
+  ·
+  <a href="https://discord.gg/NQPKmU5CCg">Join Discord</a>
+  ·
+  <a href="https://www.reddit.com/r/AIMemory/">Join r/AIMemory</a>
+  .
+  <a href="https://docs.cognee.ai/">Docs</a>
+  .
+  <a href="https://github.com/topoteretes/cognee-community">cognee community repo</a>
+  </p>
+
+
+  [![GitHub forks](https://img.shields.io/github/forks/topoteretes/cognee.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/topoteretes/cognee/network/)
+  [![GitHub stars](https://img.shields.io/github/stars/topoteretes/cognee.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/topoteretes/cognee/stargazers/)
+  [![GitHub commits](https://badgen.net/github/commits/topoteretes/cognee)](https://GitHub.com/topoteretes/cognee/commit/)
+  [![Github tag](https://badgen.net/github/tag/topoteretes/cognee)](https://github.com/topoteretes/cognee/tags/)
+  [![Downloads](https://static.pepy.tech/badge/cognee)](https://pepy.tech/project/cognee)
+  [![License](https://img.shields.io/github/license/topoteretes/cognee?colorA=00C586&colorB=000000)](https://github.com/topoteretes/cognee/blob/main/LICENSE)
+  [![Contributors](https://img.shields.io/github/contributors/topoteretes/cognee?colorA=00C586&colorB=000000)](https://github.com/topoteretes/cognee/graphs/contributors)
+  <a href="https://github.com/sponsors/topoteretes"><img src="https://img.shields.io/badge/Sponsor-❤️-ff69b4.svg" alt="Sponsor"></a>
+
+<p>
+  <a href="https://www.producthunt.com/posts/cognee?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-cognee" target="_blank" style="display:inline-block; margin-right:10px;">
+    <img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=946346&theme=light&period=daily&t=1744472480704" alt="cognee - Memory&#0032;for&#0032;AI&#0032;Agents&#0032;&#0032;in&#0032;5&#0032;lines&#0032;of&#0032;code | Product Hunt" width="250" height="54" />
+  </a>
+
+  <a href="https://trendshift.io/repositories/13955" target="_blank" style="display:inline-block;">
+    <img src="https://trendshift.io/api/badge/repositories/13955" alt="topoteretes%2Fcognee | Trendshift" width="250" height="55" />
+  </a>
+</p>
+
+
+
+**🚀 We launched Cogwit beta (Fully-hosted AI Memory): Sign up [here](https://platform.cognee.ai/)! 🚀**
+
+Build dynamic memory for Agents and replace RAG 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)
+
+  <p align="center">
+  🌐 Available Languages
+  :
+  <!-- Keep these links. Translations will automatically update with the README. -->
+  <a href="https://www.readme-i18n.com/topoteretes/cognee?lang=de">Deutsch</a> |
+  <a href="https://www.readme-i18n.com/topoteretes/cognee?lang=es">Español</a> |
+  <a href="https://www.readme-i18n.com/topoteretes/cognee?lang=fr">français</a> |
+  <a href="https://www.readme-i18n.com/topoteretes/cognee?lang=ja">日本語</a> |
+  <a href="https://www.readme-i18n.com/topoteretes/cognee?lang=ko">한국어</a> |
+  <a href="https://www.readme-i18n.com/topoteretes/cognee?lang=pt">Português</a> |
+  <a href="https://www.readme-i18n.com/topoteretes/cognee?lang=ru">Русский</a> |
+  <a href="https://www.readme-i18n.com/topoteretes/cognee?lang=zh">中文</a>
+  </p>
+
+
+<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%" />
+</div>
+</div>
+
+
+## Features
+
+- Interconnect and retrieve your past conversations, documents, images and audio transcriptions
+- Replaces RAG systems and reduces developer effort, and cost.
+- Load data to graph and vector databases using only Pydantic
+- Manipulate your data while ingesting from 30+ data sources
+
+## Get Started
+
+Get started quickly with a Google Colab  <a href="https://colab.research.google.com/drive/1jHbWVypDgCLwjE71GSXhRL3YxYhCZzG1?usp=sharing">notebook</a> , <a href="https://deepnote.com/workspace/cognee-382213d0-0444-4c89-8265-13770e333c02/project/cognee-demo-78ffacb9-5832-4611-bb1a-560386068b30/notebook/Notebook-1-75b24cda566d4c24ab348f7150792601?utm_source=share-modal&utm_medium=product-shared-content&utm_campaign=notebook&utm_content=78ffacb9-5832-4611-bb1a-560386068b30">Deepnote notebook</a> or  <a href="https://github.com/topoteretes/cognee/tree/main/cognee-starter-kit">starter repo</a>
+
+
+
+
+## Contributing
+Your contributions are at the core of making this a true open source project. Any contributions you make are **greatly appreciated**. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information.
+
+
+
+
+
+## 📦 Installation
+
+You can install Cognee using either **pip**, **poetry**, **uv** or any other python package manager.
+
+Cognee supports Python 3.10 to 3.13
+
+### With pip
+
+```bash
+pip install cognee
+```
+
+## Local Cognee installation
+
+You can install the local Cognee repo using **uv**, **pip** and **poetry**.
+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
+
+```
+import os
+os.environ["LLM_API_KEY"] = "YOUR OPENAI_API_KEY"
+
+```
+
+You can also set the variables by creating .env file, using our <a href="https://github.com/topoteretes/cognee/blob/main/.env.template">template.</a>
+To use different LLM providers, for more info check out our <a href="https://docs.cognee.ai">documentation</a>
+
+
+### Simple example
+
+This script will run the default pipeline:
+
+```python
+import cognee
+import asyncio
+
+
+async def main():
+    # Add text to cognee
+    await cognee.add("Natural language processing (NLP) is an interdisciplinary subfield of computer science and information retrieval.")
+
+    # Generate the knowledge graph
+    await cognee.cognify()
+
+    # Query the knowledge graph
+    results = await cognee.search("Tell me about NLP")
+
+    # Display the results
+    for result in results:
+        print(result)
+
+
+if __name__ == '__main__':
+    asyncio.run(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.
+
+```
+
+## Our paper is out! <a href="https://arxiv.org/abs/2505.24478" target="_blank" rel="noopener noreferrer">Read here</a>
+
+<div style="text-align: center">
+  <img src="assets/cognee-paper.png" alt="cognee paper" width="100%" />
+</div>
+
+</div>
+
+## Cognee UI
+
+You can also cognify your files and query using cognee UI.
+
+<img src="assets/cognee-new-ui.webp" width="100%" alt="Cognee UI 2"></a>
+
+Try cognee UI by runnning ``` cognee -ui ``` command on your terminal.
+
+## Understand our architecture
+
+<div style="text-align: center">
+  <img src="assets/cognee_diagram.png" alt="cognee concept diagram" width="100%" />
+</div>
+
+
+
+## Demos
+
+1. Cogwit Beta demo:
+
+[Cogwit Beta](https://github.com/user-attachments/assets/fa520cd2-2913-4246-a444-902ea5242cb0)
+
+2. Simple GraphRAG demo
+
+[Simple GraphRAG demo](https://github.com/user-attachments/assets/d80b0776-4eb9-4b8e-aa22-3691e2d44b8f)
+
+3. cognee with Ollama
+
+[cognee with local models](https://github.com/user-attachments/assets/8621d3e8-ecb8-4860-afb2-5594f2ee17db)
+
+
+## Code of Conduct
+
+We are committed to making open source an enjoyable and respectful experience for our community. See <a href="https://github.com/topoteretes/cognee/blob/main/CODE_OF_CONDUCT.md"><code>CODE_OF_CONDUCT</code></a> for more information.
+
+## 💫 Contributors
+
+<a href="https://github.com/topoteretes/cognee/graphs/contributors">
+  <img alt="contributors" src="https://contrib.rocks/image?repo=topoteretes/cognee"/>
+</a>
+
+## Sponsors
+
+Thanks to the following companies for sponsoring the ongoing development of cognee.
+
+- [GitHub's Secure Open Source Fund](https://resources.github.com/github-secure-open-source-fund/)
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=topoteretes/cognee&type=Date)](https://star-history.com/#topoteretes/cognee&Date)