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

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-2.4.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.4.0.tar.gz
Algorithm Hash digest
SHA256 ed1bc52a5f2a5c1fc25794668aae222e6ad8454b4fd856100a2a2ba6d890329a
MD5 a2b47afc56a3e04a8c30814c77cd89b2
BLAKE2b-256 0bbdc492eb4094a94729c5763aef74db17b83770dbf1a7a02b8c01baaddc706c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-2.4.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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b1ccde477e9427a6d1a93cefdd4b422e583f05d32c233f7c2323df2732db7138
MD5 528884763981e8e7fa02e26440073540
BLAKE2b-256 81fab3ffb3dca2e0762a7bb47303d72d03617e185e06634e250a7a3ef5db95b8

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