Skip to main content

A library for LLM-based agents to navigate large codebases efficiently.

Project description

Locify 🔎

PyPI - Python Versions PyPI - Package Version GitHub - License Docs - GitHub.io

Locify is a library designed to help LLM-based agents navigate and analyze large codebases efficiently. It leverages parsing techniques to provide insights into code structure and relationships.

Features

On a Git-based repository, Locify offers:

  • Codebase Skeleton Mapping:

    • FullMapStrategy: Generates a skeleton map of the entire codebase or a directory only.
    • RepoMapStrategy: Focuses on the reference relationships, using graph theory to rank and analyze code elements.
  • Tree-sitter Integration: Utilizes Tree-sitter for precise parsing of source code, supporting multiple programming languages.

  • Command-Line Interface: Provides a user-friendly CLI for executing different mapping strategies.

Installation

Locify can be installed via pip:

pip install locify

Usage

Command-Line Interface

Locify offers a CLI to execute mapping strategies:

python -m locify.cli <strategy> get_map_with_token_count [options]
  • <strategy>: Choose between fullmap and repomap.
  • [options]: Additional options for customizing the mapping process, e.g. file's depth, or specific directories only.

Example

  • To generate a full map of a codebase:

    python -m locify.cli fullmap get_map_with_token_count --root /path/to/gitrepo
    
  • To generate a full map of the locify directory only, with maximum depth of 3:

    python -m locify.cli fullmap get_map_with_token_count 3 locify
    

Development

Directory Structure

  • locify/: Main source code directory.
    • cli.py: Command-line interface implementation.
    • indexing/: Contains strategies for code mapping.
      • full_map/: Implementation of FullMapStrategy.
      • repo_map/: Implementation of RepoMapStrategy.
    • tree_sitter/: Tree-sitter integration for parsing.
      • parser.py: Tree-sitter parser implementation.
      • queries/: Schema query files for different languages.
    • utils/: Utility functions and classes.

Testing

Tests are located in the tests directory. Run tests using:

poetry run pytest

Acknowledgements

This project was inspired by the aider's RepoMap implementation.

License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.

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

locify-0.0.5.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

locify-0.0.5-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file locify-0.0.5.tar.gz.

File metadata

  • Download URL: locify-0.0.5.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.4 Linux/6.5.0-1025-azure

File hashes

Hashes for locify-0.0.5.tar.gz
Algorithm Hash digest
SHA256 bd1e2db3ad83a52673be04c4c40fd1e6b7e04180616a6bfc578611e728c58ddb
MD5 3883a3b7593b743368c69d64d5d017f4
BLAKE2b-256 60f874f95630d7ac0627535597d43015624fe95898b32f7e5e321442411d0a30

See more details on using hashes here.

File details

Details for the file locify-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: locify-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.4 Linux/6.5.0-1025-azure

File hashes

Hashes for locify-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 98a77932ed67b37a117c1632dac633c162952d89270a394c4ec63c13685baf46
MD5 3405a618eb1a8735ef03363a0a89a1df
BLAKE2b-256 9f9da94cf266bfc80dfa98ab556e36eda0b5c5ae9efe82e8973f271a2ed98775

See more details on using hashes here.

Supported by

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