Rename repo2vec to CodeSage (#34)

* mv repo2vec codesage

* s/repo2vec/codesage

* s/r2v/cs

* Update installation instructions (no pypi for now because of rapid development)

* Add badges

.gitignore

@@ -3,4 +3,4 @@ __pycache__
 *.cpython.*
 build/
 repos/
-repo2vec.egg-info/
+codesage.egg-info/

MANIFEST.in

@@ -1 +1 @@
-include repo2vec/sample-exclude.txt
+include codesage/sample-exclude.txt

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <h1 align="center">repo2vec</h1>
+  <h1 align="center">Code Sage</h1>
   <p align="center">An open-source pair programmer for chatting with any codebase.</p>
   <figure>
     <img src="assets/chat_screenshot2.png" alt="screenshot" style="max-height: 500px; border: 1px solid black;">
@@ -7,17 +7,43 @@
   </figure>
 </div>
 
+<div align="center">
+  </br>
+    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/Storia-AI/CodeSage?logo=github" />
+    <img alt="GitHub License" src="https://img.shields.io/github/license/Storia-AI/CodeSage"></img>
+    <img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/StoriaAI"></img>
+  </br>
+</div>
+
 # Getting started
 
 ## Installation
 
-To install the library, simply run `pip install repo2vec`!
+<details open>
+<summary><strong>Using pipx (recommended) </strong></summary>
+Make sure pipx is installed on your system (see <a href="https://pipx.pypa.io/stable/installation/">instructions</a>), then run:
+
+```
+pipx install git+https://github.com/Storia-AI/CodeSage.git@main
+```
 
-:exclamation: **Please make sure you have the latest version installed (as indicated [here](https://github.com/Storia-AI/repo2vec/blob/ca8ff43b2993ab0da3f0b807513cb4e3f7b0955f/setup.py#L11)). We're under rapid development and older versions quickly become obsolete.** To check your latest version, you can run `pip list | grep repo2vec`.
+</details>
+
+<details>
+<summary><strong>Using venv and pip</strong></summary>
+Alternatively, you can manually create a virtual environment and install Code Sage via pip:
+
+```
+python -m venv codesage-venv
+source codesage-venv/bin/activate
+pip install git+https://github.com/Storia-AI/CodeSage.git@main
+```
+
+</details>
 
 ## Prerequisites
 
-`repo2vec` performs two steps:
+`codesage` performs two steps:
 
 1. Indexes your codebase (requiring an embdder and a vector store)
 2. Enables chatting via LLM + RAG (requiring access to an LLM)
@@ -84,12 +110,12 @@ If you are planning on indexing GitHub issues in addition to the codebase, you w
 
 2. Index the repository. This might take a few minutes, depending on its size.
     ```
-    r2v-index $GITHUB_REPO
+    cs-index $GITHUB_REPO
     ```
 
 3. Chat with the repository, once it's indexed:
     ```
-    r2v-chat $GITHUB_REPO
+    cs-chat $GITHUB_REPO
     ```
     To get a public URL for your chat app, set `--share=true`.
 
@@ -105,7 +131,7 @@ If you are planning on indexing GitHub issues in addition to the codebase, you w
 
 2. Index the repository. This might take a few minutes, depending on its size.
     ```
-    r2v-index $GITHUB_REPO \
+    cs-index $GITHUB_REPO \
         --embedder-type=openai \
         --vector-store=pinecone \
         --index-name=$PINECONE_INDEX_NAME
@@ -113,7 +139,7 @@ If you are planning on indexing GitHub issues in addition to the codebase, you w
 
 3. Chat with the repository, once it's indexed:
     ```
-    r2v-chat $GITHUB_REPO \
+    cs-chat $GITHUB_REPO \
         --vector-store-type=pinecone \
         --index-name=$PINECONE_INDEX_NAME \
         --llm-provider=openai \
@@ -147,14 +173,14 @@ where:
 
 To specify an inclusion file (i.e. only index the specified files):
 ```
-r2v-index $GITHUB_REPO --include=/path/to/inclusion/file
+cs-index $GITHUB_REPO --include=/path/to/inclusion/file
 ```
 
 To specify an exclusion file (i.e. index all files, except for the ones specified):
 ```
-r2v-index $GITHUB_REPO --exclude=/path/to/exclusion/file
+cs-index $GITHUB_REPO --exclude=/path/to/exclusion/file
 ```
-By default, we use the exclusion file [sample-exclude.txt](repo2vec/sample-exclude.txt).
+By default, we use the exclusion file [sample-exclude.txt](codesage/sample-exclude.txt).
 </details>
 
 <details>
@@ -166,17 +192,17 @@ export GITHUB_TOKEN=...
 
 To index GitHub issues without comments:
 ```
-r2v-index $GITHUB_REPO --index-issues
+cs-index $GITHUB_REPO --index-issues
 ```
 
 To index GitHub issues with comments:
 ```
-r2v-index $GITHUB_REPO --index-issues --index-issue-comments
+cs-index $GITHUB_REPO --index-issues --index-issue-comments
 ```
 
 To index GitHub issues, but not the codebase:
 ```
-r2v-index $GITHUB_REPO --index-issues --no-index-repo
+cs-index $GITHUB_REPO --index-issues --no-index-repo
 ```
 </details>
 
@@ -185,7 +211,7 @@ r2v-index $GITHUB_REPO --index-issues --no-index-repo
 Sometimes you just want to learn how a codebase works and how to integrate it, without spending hours sifting through
 the code itself.
 
-`repo2vec` is like an open-source GitHub Copilot with the most up-to-date information about your repo.
+`codesage` is like an open-source GitHub Copilot with the most up-to-date information about your repo.
 
 Features:
 
@@ -196,8 +222,7 @@ Features:
 
 # Changelog
 
-- 2024-09-06: Updated command names to `r2v-index` and `r2v-chat` to avoid clash with local utilities.
-- 2024-09-03: `repo2vec` is now available on pypi.
+- 2024-09-16: Renamed `repo2vec` to `codesage`.
 - 2024-09-03: Support for indexing GitHub issues.
 - 2024-08-30: Support for running everything locally (Marqo for embeddings, Ollama for LLMs).
 

{repo2vec → codesage}/chat.py

@@ -12,8 +12,8 @@ from langchain.chains.combine_documents import create_stuff_documents_chain
 from langchain.schema import AIMessage, HumanMessage
 from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder
 
-import repo2vec.vector_store as vector_store
-from repo2vec.llm import build_llm_via_langchain
+import codesage.vector_store as vector_store
+from codesage.llm import build_llm_via_langchain
 
 load_dotenv()
 

{repo2vec → codesage}/data_manager.py

@@ -35,7 +35,7 @@ class GitHubRepoManager(DataManager):
     ):
         """
         Args:
-            repo_id: The identifier of the repository in owner/repo format, e.g. "Storia-AI/repo2vec".
+            repo_id: The identifier of the repository in owner/repo format, e.g. "Storia-AI/codesage".
             local_dir: The local directory where the repository will be cloned.
             inclusion_file: A file with a lists of files/directories/extensions to include. Each line must be in one of
                 the following formats: "ext:.my-extension", "file:my-file.py", or "dir:my-directory".

{repo2vec → codesage}/embedder.py

@@ -11,8 +11,8 @@ from typing import Dict, Generator, List, Optional, Tuple
 import marqo
 from openai import OpenAI
 
-from repo2vec.chunker import Chunk, Chunker
-from repo2vec.data_manager import DataManager
+from codesage.chunker import Chunk, Chunker
+from codesage.data_manager import DataManager
 
 Vector = Tuple[Dict, List[float]]  # (metadata, embedding)
 

{repo2vec → codesage}/github.py

@@ -8,8 +8,8 @@ from typing import Any, Dict, Generator, List, Tuple
 import requests
 import tiktoken
 
-from repo2vec.chunker import Chunk, Chunker
-from repo2vec.data_manager import DataManager
+from codesage.chunker import Chunk, Chunker
+from codesage.data_manager import DataManager
 
 tokenizer = tiktoken.get_encoding("cl100k_base")
 

{repo2vec → codesage}/index.py

@@ -7,11 +7,11 @@ import time
 
 import pkg_resources
 
-from repo2vec.chunker import UniversalFileChunker
-from repo2vec.data_manager import GitHubRepoManager
-from repo2vec.embedder import build_batch_embedder_from_flags
-from repo2vec.github import GitHubIssuesChunker, GitHubIssuesManager
-from repo2vec.vector_store import build_from_args
+from codesage.chunker import UniversalFileChunker
+from codesage.data_manager import GitHubRepoManager
+from codesage.embedder import build_batch_embedder_from_flags
+from codesage.github import GitHubIssuesChunker, GitHubIssuesManager
+from codesage.vector_store import build_from_args
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger()

setup.py

@@ -7,18 +7,18 @@ def readfile(filename):
 
 
 setup(
-    name="repo2vec",
-    version="0.1.8",
+    name="codesage",
+    version="0.1.0",
     packages=find_packages(),
     include_package_data=True,
     package_data={
-        "repo2vec": ["sample-exclude.txt"],
+        "codesage": ["sample-exclude.txt"],
     },
     install_requires=open("requirements.txt").readlines() + ["setuptools"],
     entry_points={
         "console_scripts": [
-            "r2v-index=repo2vec.index:main",
-            "r2v-chat=repo2vec.chat:main",
+            "cs-index=codesage.index:main",
+            "cs-chat=codesage.chat:main",
         ],
     },
     author="Julia Turc & Mihail Eric / Storia AI",
@@ -26,7 +26,7 @@ setup(
     description="A library to index a code repository and chat with it via LLMs.",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
-    url="https://github.com/Storia-AI/repo2vec",
+    url="https://github.com/Storia-AI/codesage",
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",

tests/conftest.py

@@ -1,4 +1,4 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../repo2vec")))
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../codesage")))

tests/test_chunker.py

@@ -11,12 +11,12 @@ import os
 
 from pytest import mark, param
 
-import repo2vec.chunker
+import codesage.chunker
 
 
 def test_text_chunker_happy_path():
     """Tests the happy path for the TextFileChunker."""
-    chunker = repo2vec.chunker.TextFileChunker(max_tokens=100)
+    chunker = codesage.chunker.TextFileChunker(max_tokens=100)
 
     file_path = os.path.join(os.path.dirname(__file__), "../README.md")
     with open(file_path, "r") as file:
@@ -29,9 +29,9 @@ def test_text_chunker_happy_path():
 
 def test_code_chunker_happy_path():
     """Tests the happy path for the CodeFileChunker."""
-    chunker = repo2vec.chunker.CodeFileChunker(max_tokens=100)
+    chunker = codesage.chunker.CodeFileChunker(max_tokens=100)
 
-    file_path = os.path.join(os.path.dirname(__file__), "../repo2vec/chunker.py")
+    file_path = os.path.join(os.path.dirname(__file__), "../codesage/chunker.py")
     with open(file_path, "r") as file:
         content = file.read()
     metadata = {"file_path": file_path}
@@ -48,22 +48,22 @@ def test_code_chunker_typescript(filename):
         content = file.read()
     metadata = {"file_path": file_path}
 
-    chunker = repo2vec.chunker.CodeFileChunker(max_tokens=100)
+    chunker = codesage.chunker.CodeFileChunker(max_tokens=100)
     chunks = chunker.chunk(content, metadata)
     # There's a bug in the tree-sitter-language-pack library for TypeScript. Before it gets fixed, we expect this to
     # return an empty list (instead of crashing).
     assert len(chunks) == 0
 
     # However, the UniversalFileChunker should fallback onto a regular text chunker, and return some chunks.
-    chunker = repo2vec.chunker.UniversalFileChunker(max_tokens=100)
+    chunker = codesage.chunker.UniversalFileChunker(max_tokens=100)
     chunks = chunker.chunk(content, metadata)
     assert len(chunks) >= 1
 
 
 def test_ipynb_chunker_happy_path():
     """Tests the happy path for the IPynbChunker."""
-    code_chunker = repo2vec.chunker.CodeFileChunker(max_tokens=100)
-    chunker = repo2vec.chunker.IpynbFileChunker(code_chunker)
+    code_chunker = codesage.chunker.CodeFileChunker(max_tokens=100)
+    chunker = codesage.chunker.IpynbFileChunker(code_chunker)
 
     file_path = os.path.join(os.path.dirname(__file__), "assets/sample-notebook.ipynb")
     with open(file_path, "r") as file: