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.6.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.6-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-1.11.6.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.6.tar.gz
Algorithm Hash digest
SHA256 7f51dababd4493e6cca4d3ccd908488a5825dce3b5f0075741d86ecfb4ad07f9
MD5 9f3c1c72e496eec25a0fd4a70f103a59
BLAKE2b-256 1676431fbf7c597f5265582b94ad534fbf89bdcc45140747de86cfa0af2458b4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-1.11.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e829bf1d974170a3667c00f7299a7f289ce5af99a3288b2b8833f9c245cd3268
MD5 3eab80d29fe3f57a84765e11d5aedf8d
BLAKE2b-256 c3ac6d5f08dd7d468399b43049d3c981542d7ece09974e2659cbae2fbda74887

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