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.0.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.0.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-2.0.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.7 Linux/6.2.0-1019-azure

File hashes

Hashes for proto_kortex-2.0.0.tar.gz
Algorithm Hash digest
SHA256 fef66fd4e85fc9761c661547ac34d78eba9c0d7b30e2fefd5772b7d4c46e077f
MD5 72b711fb51edacbd69b041deb22b392f
BLAKE2b-256 e1c1ef87941de12dcedf254ed6f574d68142a7019cf29e745ba8b853f5cff9e0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-2.0.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.7 Linux/6.2.0-1019-azure

File hashes

Hashes for proto_kortex-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 638a495a286648359f4ef5f4949a6a9e23348eca94399e4fe2c9a7537d0283ca
MD5 a5ff3f4fcde0aaa2fe00fe5fb7fe9451
BLAKE2b-256 49669ebccd9e05e1c64627001984b259c134ed3b6f2ef820a1c269993eca609b

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