lookout-sdk 0.3.1

SDK for writing lookout analyzers

lookout-sdk

Toolkit for writing new analyzers for source{d} Lookout.

What Does the SDK Provide?

For the complete documentation of source{d} Lookout, please take a look at https://docs.sourced.tech/lookout.

For detailed information about the different parts of Lookout, and how they interact you can go to the Lookout architecture guide.

lookout-sdk provides:

• proto definitions.
• pre-generated libraries for Golang and Python, offering:
  • an easy access to the DataService API though a gRPC service. Lookout will take care of dealing with Git repositories, UAST extraction, programming language detection, etc.
  • low-level helpers to work around some protobuf/gRPC caveats.
• quickstart examples of an Analyzer that detects language and number of functions (written in Go and in Python).

Caveats

For the gRPC client and server please follow these requirements:

• set a common maximum gRPC message size in gRPC servers and clients. This is required to avoid hitting different gRPC limits when handling UASTs, that can be huge —see grpc/grpc#7927—. To do so use the included helpers in lookout-sdk:
  • go: using pb.NewServer and pb.DialContext.
  • python: using lookout.sdk.grpc.create_channel.
• support RFC 3986 URI scheme; lookout-sdk includes helpers for this:
  • go: using pb.ToGoGrpcAddress and pb.Listen.
  • python: using lookout.sdk.grpc.to_grpc_address.

DataService

When DataService is being dialed, you should:

• disable secure connection:
  • go: using grpc.WithInsecure() (example).
  • python: using server.add_insecure_port(address) (example).
• turn off gRPC fail-fast mode if your analyzer creates a connection to DataServer before it was actually started. This way the RPCs are queued until the chanel is ready:
  • go: using grpc.FailFast(false) (example).

Contributing

Contributions are welcome and very much appreciated 🙌

Please refer to our Contribution Guide for more details.

Community

source{d} has an amazing community of developers and contributors who are interested in Code As Data and/or Machine Learning on Code. Please join us! 👋

• Slack
• Twitter
• Email

Code of Conduct

All activities under source{d} projects are governed by the source{d} code of conduct.

License

Apache License Version 2.0, see LICENSE