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.8.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-1.11.8-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-1.11.8.tar.gz
  • Upload date:
  • Size: 9.2 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.8.tar.gz
Algorithm Hash digest
SHA256 d3739cd1a987c271cf98fa19944868ffc6eeaf0e0cd92a839757c432b4585401
MD5 3fa2f54afc18a9f5025a27efd3e0b691
BLAKE2b-256 b9136cbf62d58fc80597bbbe28241418792fc30ea84ba7a27d3985512bdf1e6c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-1.11.8-py3-none-any.whl
  • Upload date:
  • Size: 10.1 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ebed3acfa7d676a1d4826be04fb9827eff71f9302db35d7d4285df97189a86e7
MD5 bb51f791c1e052b923b65acd0264d541
BLAKE2b-256 966b79183983f3526669334976a99254ad5deea4e5f6cc2c4cff3974e466498b

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