lsproxy SDK

A Python SDK for interacting with the lsproxy container, providing language-server protocol functionality for code analysis across multiple languages.

Features

• Symbol definition lookup
• Reference lookup across files
• Support for analyzing Python, TypeScript/JavaScript, and Rust
• Pydantic models for type safety

Try it out!

If you just want to get a feel for lsproxy try out the tutorial at demo.lsproxy.dev

Installation

pip install lsproxy-sdk

Usage

You can use lsproxy either by running a local server or using Modal cloud infrastructure.

Using Modal

First, install the Modal dependencies:

pip install 'lsproxy-sdk[modal]'

Then use the SDK:

from lsproxy import Lsproxy

# Synchronous usage
lsp = Lsproxy.initialize_with_modal(
    repo_url="https://github.com/username/repo",
    git_token="your-github-token",  # Optional, for private repos
)

# Async usage
from lsproxy import AsyncLsproxy
import asyncio

async def main():
    lsp = await AsyncLsproxy.initialize_with_modal(
        repo_url="https://github.com/username/repo"
    )
    try:
        files = await lsp.list_files()
    finally:
        await lsp.close()

asyncio.run(main())

Using Local Server

1. Start the LSProxy container:

docker run --rm -d -p 4444:4444 -v "/path/to/your/code:/mnt/workspace" -e USE_AUTH=false --name lsproxy agenticlabs/lsproxy:0.3.5

2. Use the SDK:

# Synchronous usage
from lsproxy import Lsproxy

lsp = Lsproxy()

# Async usage
from lsproxy import AsyncLsproxy
import asyncio

async def main():
    async with AsyncLsproxy() as lsp:
        # Use async methods
        files = await lsp.list_files()
        
# Run the async code
asyncio.run(main())

List all files in the workspace

lsp.list_files()

Get symbols in a file

lsp.definitions_in_file(path="path/to/file.py")

Get references to a symbol

# Find all references to a symbol at a specific position
references = lsp.find_references(
    GetReferencesRequest(
        identifier_position=FilePosition(
            file_path="path/to/file.py",
            line=10,
            character=15
        ),
        include_code_context_lines=2,  # Show 2 lines of context around each reference
        include_declaration=True       # Include the original declaration
    )
)

# Print found references
for ref in references.references:
    print(f"Reference in {ref.file_path} at line {ref.range.start.line}")
    if ref.code_context:
        print(ref.code_context)