https://github.com/sourcegraph/srclib-python

https://github.com/sourcegraph/srclib-python

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sourcegraph/srclib-python
• Owner: sourcegraph
• Archived: true
• Created: 2014-07-19T08:12:33.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-07-06T20:35:37.000Z (over 8 years ago)
• Last Synced: 2024-05-23T04:48:03.041Z (6 months ago)
• Language: Python
• Homepage: https://sourcegraph.com/sourcegraph/srclib-python
• Size: 2.11 MB
• Stars: 28
• Watchers: 88
• Forks: 13
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# srclib-python [![Build Status](https://travis-ci.org/sourcegraph/srclib-python.png?branch=master)](https://travis-ci.org/sourcegraph/srclib-python)

## Jedi

**srclib-python** is a [srclib](https://sourcegraph.com/sourcegraph/srclib)

toolchain that performs Python code analysis: type checking, documentation

generation, jump-to-definition, dependency resolution, etc.

It enables this functionality in any client application whose code analysis is

powered by srclib, including [Sourcegraph.com](https://sourcegraph.com).

## Installation

This toolchain is not a standalone program; it provides additional functionality

to applications that use [srclib](https://srclib.org).

First,

[install the `srclib` program (see srclib installation instructions)](https://srclib.org/gettingstarted/).

Installing `srclib` should automatically install `srclib-python`.

To verify that installation succeeded, run:

```

srclib toolchain list

```

You should see this srclib-python toolchain in the list.

Now that this toolchain is installed, any program that relies on srclib will support Python.

## Known issues

srclib-python is alpha-quality software. It powers code analysis on

[Sourcegraph.com](https://sourcegraph.com) but has not been widely tested or

adapted for other use cases.

It also expects projects to follow best practices such as including a `setup.py` file. It doesn't currently handle

decorators or namespace packages correctly.

There also seems to be a problem with some function parameter type detection.

srclib-python runs on Python 2.7 (and some glue code in Go), but it can still process Python 3 libraries.

## Misc

srclib-python's type analysis is based on

[Jedi](https://github.com/davidhalter/jedi).