Documentation | Get Started | Developer Chat

DeepSource helps you ship good quality code.

---

Beacon Python client library - beacon-py

DeepSource Dashboard - https://deepsource.io/gh/deepsourcelabs/beacon-py/

NOTE: beacon-py is currently in a pre-release phase, so we do not recommend using it at the moment.

Beacon runs inside your Python applications and collects metrics around how the code behaves in runtime — usage of modules, volume of exceptions, to name a few. Python versions 2.7 & 3.4-3.7 are officially supported.

Beacon is open-source, and we are actively looking for contributors for the project. If you want to lend a hand, pick up an issue or join the chatter on IRC at #deepsourcelabs.

Installation

To install beacon-py, use pipenv (or pip):

$ pipenv install beacon

Running tests

$ make test

Generating gRPC client stubs

$ make generate_grpc_client

NOTE: Apparently, the stub generator generates beacon/beacon_pb2_grpc.py with a bad import of beacon_pb2. After generating the stubs, the import has to be changed manually.

Find the line:

import beacon_pb2 as beacon__pb2  # existing bad import, which should be removed

And replace it with:

from . import beacon_pb2 as beacon__pb2  # new import that should be added