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-1.11.5.tar.gz (8.9 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-1.11.5-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-1.11.5.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.6 Linux/6.2.0-1016-azure

File hashes

Hashes for proto_kortex-1.11.5.tar.gz
Algorithm Hash digest
SHA256 5499706a6a0e3793177958557cea6c1d524c4a6357a0192572975130bd50a8ed
MD5 9f289b11914f77ddcaa1d051c603df38
BLAKE2b-256 ed2dcb4f47ceb3845730b58f393aa50a8e0d9bd4cde54421d620c45415aa0942

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for proto_kortex-1.11.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7b4edfd667ab5b8c4454b9d88c21376f1e637a09274fdbf4cc0d8efa8b572c84
MD5 3321380599ed8579a4bb429cfd9ec541
BLAKE2b-256 e3328c73936e70c76b0a3b6bf5e1e59d63f19ab85649081de0761e1e95e7e319

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