# lsif-py

**Repository Path**: mirrors_sourcegraph/lsif-py

## Basic Information

- **Project Name**: lsif-py
- **Description**: Language Server Indexing Format (LSIF) generator for Python
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2025-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# (Deprecated) Python LSIF Indexer ![](https://img.shields.io/badge/status-deprecated-red)

This project is no longer maintained. Please use [scip-python](https://github.com/sourcegraph/scip-python) instead.

See below for the unmaintained documentation on how to use this project.

🚨 This implementation is in its infancy and conforms to the [0.4.0 draft of the LSIF spec](https://github.com/Microsoft/language-server-protocol/blob/master/indexFormat/specification.md).

## Language Server Index Format

The purpose of the Language Server Index Format (LSIF) is to define a standard format for language servers and related tools to dump their knowledge about a workspace. The dump is basically a pre-computed set of responses that a language server *would* send back about a particular range of source code.

## Basic Usage

To run the indexer, simply run the provided shell script wrapper and provide a workspace directory to be indexed.

```
$ ./lsif-py lsif_indexer
Indexing file lsif_indexer/analysis.py
Indexing file lsif_indexer/index.py
Indexing file lsif_indexer/__init__.py
Indexing file lsif_indexer/consts.py
Indexing file lsif_indexer/script.py
Indexing file lsif_indexer/emitter.py

Processed in 2834.89ms
```

Verbose logging can be enabled with `-v`. The dump file is `data.lsif` by default, but can be changed via the `-o <filename>` flag.

## Installation Notes

The indexer requires Python 3.x. To install dependencies, run:

```shell
pip install -r requirements.txt
```

If you don't want to install dependencies globally, use `virtualenv`:

```shell
$ virtualenv venv
$ source venv/bin/activate
(venv) $ pip install -r requirements.txt
(venv) $ ./lsif-py lsif_indexer
# ...
(venv) $ deactivate
$
```

### Installation on macOS

On macOS, where the system Python on macOS is still 2.7.x, you can install Python 3 via [Homebrew](https://brew.sh/):

```shell
brew install python@3
```

You may need to write `pip3` instead of `pip` to get the correct version.