Skip to main content

A modular toolkit for LLM-powered codebase understanding.

Project description

kit 🛠️ Code Intelligence Toolkit

kit is a modular, production-grade Python toolkit for codebase mapping, symbol extraction, code search, and building LLM-powered developer tools, agents, and workflows.

Use kit to build things like code reviewers, code generators, even IDEs, all enriched with the right code context.

Quick Installation

Install from PyPI

# Installation (includes all features)
pip install cased-kit

Install from Source

git clone https://github.com/cased/kit.git
cd kit
uv venv .venv
source .venv/bin/activate
uv pip install -e .

Basic Usage

from kit import Repository

# Load a local repository
repo = Repository("/path/to/your/local/codebase")

# Load a remote public GitHub repo
# repo = Repository("https://github.com/owner/repo")

# Explore the repo
print(repo.get_file_tree())
# Output: [{"path": "src/main.py", "is_dir": False, ...}, ...]

print(repo.extract_symbols('src/main.py'))
# Output: [{"name": "main", "type": "function", "file": "src/main.py", ...}, ...]

Key Features & Capabilities

kit helps your apps and agents deeply understand and interact with codebases, providing the core components to build your own AI-powered developer tools. Here are just a few of the things you can do:

  • Explore Code Structure:

    • Get a bird's-eye view with repo.get_file_tree() to list all files and directories.
    • Dive into specifics with repo.extract_symbols() to identify all functions, classes, and other code constructs, either across the entire repository or within a single file.
  • Pinpoint Information:

    • Perform precise textual or regular expression searches across your codebase using repo.search_text().
    • Track down every definition and reference of a specific symbol (like a function or class) with repo.find_symbol_usages().
  • Prepare Code for LLMs & Analysis:

    • Break down large files into manageable pieces for LLM context windows using repo.chunk_file_by_lines() or repo.chunk_file_by_symbols().
    • Instantly grab the full definition of a function or class just by knowing a line number within it using repo.extract_context_around_line().
  • Generate Code Summaries (Alpha):

    • Leverage LLMs to create natural language summaries for files, functions, or classes using the Summarizer (e.g., summarizer.summarize_file(), summarizer.summarize_function()).
    • Build a searchable semantic index of these AI-generated docstrings with DocstringIndexer and query it with SummarySearcher to find code based on intent and meaning.
  • And much more... kit also offers capabilities for semantic search on raw code, building custom context for LLMs, and more.

Explore the Full Documentation for detailed usage, advanced features, and practical examples.

License

MIT License

Contributing

We welcome contributions! Please see our Roadmap for project directions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cased_kit-0.1.2.tar.gz (55.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cased_kit-0.1.2-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

Details for the file cased_kit-0.1.2.tar.gz.

File metadata

  • Download URL: cased_kit-0.1.2.tar.gz
  • Upload date:
  • Size: 55.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for cased_kit-0.1.2.tar.gz
Algorithm Hash digest
SHA256 fe48bffb59c63523b288d5e5ceb0b98773db00487500f82df10a18a9744e4520
MD5 767e469d066efcde1e25a2f2d1cd574e
BLAKE2b-256 bb6a46bed8bf2a1d7195022370ca5e61dc165c5562e6836b0d810ab40607e498

See more details on using hashes here.

File details

Details for the file cased_kit-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: cased_kit-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 39.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for cased_kit-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c10b7d157e148a93b663046c4359c561a723480211b91f9049cae0834d04cf72
MD5 8a0808515c5e61e8e694b00b42e7885b
BLAKE2b-256 1447e84ecb0b089febe074917147cdabf95bc92e5c9ae09dd723ac3dc4d180c6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page