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

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-1.12.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-1018-azure

File hashes

Hashes for proto_kortex-1.12.0.tar.gz
Algorithm Hash digest
SHA256 8f53eb77a67fd3d0b954a36ff4b64342a54c79d691696f356eb7c6b6544ced90
MD5 266418e599c3aff61f38429400d51b2c
BLAKE2b-256 aef1dbedcef0e31f7e7015d40008b190d49a58dfcb3af9d0ff52ca01de668abc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-1.12.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-1018-azure

File hashes

Hashes for proto_kortex-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50486481d373fdde663842e2999a43c6ea194e4c4597f51838d44c8ba6c9f911
MD5 f28a7266aa36d3d99c77b282c53b079b
BLAKE2b-256 53cd9b3f8512047cb8c60cec59eeffbe7a1ff33cec825ea1beda7800ea01b3a9

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