LIBRARY_BUILD.md

SCANOSS gRPC Library Compilation

Details for producing language specific library code from the Protocol Buffer definitions can be found here.

Protocol Buffer Details

The gRPC definitions can be found the protobuf folder.

Compilation

This gRPC API can be implemented in multiple languages. SCANOSS will provide the following:

• Go - github.com/scanoss/papi
• Python - scanoss
• Javascript - scanoss
• Java - TBD

Go

In order to build the Go library implementation of the proto definitions, the following tools are required:

• Go
• Protoc for Go

To build the Go code from the definitions, please run:

make build_go

Python

In order to build the Python library implementation of the proto definitions, the following tools are required:

• Python
• grpcio-tools

To build the Python code from the definitions, please run:

make build_python

This will save the library/package files in the python folder. These files need to be copied into the scanoss.py src folder.

There is a convenience command to copy these files, if the scanoss.py project is cloned locally beside papi:

make update_scanoss_py

Consumption of the Python gRPC APIs is provided through this package. You can install this package from PyPI.

Javascript

In order to build the Javascript library implementation of the proto definitions, the following tools are required:

• Node
• [protoc] (https://grpc.io/docs/protoc-installation/)
• ts-protoc-gen

To build the Javascript code from the definitions, please run:

make build_js

This will save the library/package files in the javascript folder. These files need to be copied into the scanoss.js src folder.

Consumption of the Javascript gRPC APIs is provided through this package. You can install this package from NPM.

Java

TBD