qpoint-io/proto

This repository contains protocol buffers definitions for Qpoint products.

This repository uses Buf for linting and code generation. Autogenerated code is available in the gen directory.

Contents

• proto/ - Protobuf definitions
  • qpoint/type/ - Common types
  • eventstore/v1/ - Event store service v1 API
  • qscan/v1/ - Qscan service v1 API
• gen/ - Autogenerated code
  • go/ - Go
  • ts/ - TypeScript
  • py/ - Python

Usage

Go

Go packages are available in gen/go/. Connect RPC service code is generated as well. To import the definitions in your project, run:

go get github.com/qpoint-io/proto

TypeScript

TypeScript modules are available in gen/ts/.

Python

Python modules are available in gen/py/. To install in your project:

# Using uv
uv add git+https://github.com/qpoint-io/proto.git

# Or using pip
pip install git+https://github.com/qpoint-io/proto.git

Then import in your code:

from eventstore.v1 import main_pb2
from qpoint.type.v1 import connection_pb2, request_pb2

Development

Make your changes in the proto/ directory. To regenerate code after making changes:

make

This will run code generation via Buf CLI in a Docker container with all the required dependencies.