sift-stack-py

Sift Python

This library offers a Python API on top of Sift's protocol buffers to ergonomically interface with the Sift gRPC API.

Installation

To install the Sift Python library:

$ pip install sift-stack-py

Documentation

Documentation can be found at this link, however, if you need to build the documentation for offline use, read on.

Offline documentation

To build the documentation locally:

Clone the main sift repository:

$ git clone https://github.com/sift-stack/sift.git

Set your working directory to this project sub-directory:

$ cd python

Install pdoc:

$ pip install pdoc

Run pdoc.

$ pdoc lib/sift_py

You may optionally set the host and port used by the pdoc web-server using the -p and -h options. See pdoc --help for more info.