Skip to main content

No project description provided

Project description

proto-kortex

Semantically versioned protobufs used to generate client packages and documentation

Protobuf Documentation

Link

Maintaining

Install the pre-commit hook to ensure any changes to the protobuf get refleted in the docs. Use Buf to lint the proto and detect breaking changes.

How to use (locally)

CI will automatically generate client packages and documentation for each release. To run locally:

Web Client

You should have make and npm installed for generating the web client.

$ npm i -g @protobuf-ts/plugin
$ make client-web

Python Client

You'll need make and pip installed for generating the python client.

$ make client-python

Create Rust crate

  1. Install Buf: https://docs.buf.build/installation
  2. Run make buf-gen
    • This should output a rust crate in the gen/crate directory that will be used by other services, such as Alexandria.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proto_kortex-2.1.0.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

proto_kortex-2.1.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file proto_kortex-2.1.0.tar.gz.

File metadata

  • Download URL: proto_kortex-2.1.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure

File hashes

Hashes for proto_kortex-2.1.0.tar.gz
Algorithm Hash digest
SHA256 8f516b49ad605f995890ef65e4491fb349af797c6de0a3309e9fd936f3427e44
MD5 d72a33258bf5b7145f026de12a1e2cff
BLAKE2b-256 25151d976d4ac07d4364ad47461a7f38dce9bd969cd8d65f379e8aafd2b2a487

See more details on using hashes here.

File details

Details for the file proto_kortex-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: proto_kortex-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure

File hashes

Hashes for proto_kortex-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80f92504a0cf16d13a7319150b7b2ff784bedd147b41cee3ab8d21155a4409de
MD5 ab652839bd4300b3dce7fc25551df241
BLAKE2b-256 6b3fbaee2ac56e55c746e6c3b27acd6204444259c72e57c57588170b9aebca57

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page