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

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-1.11.4.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.4.tar.gz
Algorithm Hash digest
SHA256 effe291ce16f923d3f07fde5bee5346542956791b0ccbd8a82826bd1f20c3409
MD5 f70b0117fa6de257e3152c008063c70e
BLAKE2b-256 9d4b6c6b117450a60f2f9c86df2e54ae5ac10e9f00939601b9e9cf9ea5f1f04b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-1.11.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e0ce20f8d2165486976f632e7cf56521d398e0fd118ef1b04d8f6f9f06d94399
MD5 bbacfd74d55dce72cf82b93c621f4174
BLAKE2b-256 fadc65d07cb5be70e750ba23a0b98532f4437ef05a28a75ba7b00191cf9bf654

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