Skip to main content

Python

To index Python we use SourceGraph's SCIP indexer for Python. SCIP is a format for tools to share information about code.

Prerequisites​

You will need:

Run the indexer​

Ensure that you have built and installed Glean and the glean executable is on your PATH.

You can index a Python repository with:

glean index python-scip DIR --db-root DB --db NAME/INSTANCE

where

  • DB is the directory where you want to store your Glean DBs
  • DIR is the root directory containing the Python project
  • NAME/INSTANCE is the name of the repository to create

In the shell​

Python source can also be indexed directly from the Glean shell:

:index python-scip DIR

The shell will pick a DB name and hash for you based on DIR.

Installing scip-to-glean​

All SCIP-based indexers require the scip-to-glean converter, which converts SCIP protobuf output into Glean facts. Install it with:

cargo install --git https://github.com/facebookincubator/Glean \
  --path glean/lang/scip/indexer/scip_to_glean/cli

This installs the scip-to-glean binary into ~/.cargo/bin. Make sure this is on your PATH.

Schema​

The schema is in glean/schema/source/scip.angle