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.3.tar.gz (8.8 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.3-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-1.11.3.tar.gz
  • Upload date:
  • Size: 8.8 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.3.tar.gz
Algorithm Hash digest
SHA256 2eb6aab664528582e32f4f9c55046ea12d65aaf4b412d0163256f5d6542791d4
MD5 1d9d0370ba3f1752865e8eb0348ced2d
BLAKE2b-256 eace4cc115f4f3cdd273c56159c4ad4941bdd8c99e36d60ec9bca978c29a2cd1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-1.11.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aa41982d669a45cd72f9d9a466c369f7aed590ede4ad28db1072874224e64063
MD5 75d2328b48091c263b100745a74c3a42
BLAKE2b-256 2cb10d2a2f19208ea35d31ff81c368f498c38114fb825fa7bdee31b14290eac8

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