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

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-2.6.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.9 Linux/6.5.0-1018-azure

File hashes

Hashes for proto_kortex-2.6.0.tar.gz
Algorithm Hash digest
SHA256 342f771c467eac3939edb2b3fa343a662d9122f1b3994aea74ca548e75a0728e
MD5 432f614830ac15cfeda77bd12a30f477
BLAKE2b-256 2c6ac070b7b21f4e83bcd8e7d8b8d4a5837b2990fb8601827181a0522e4c55a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-2.6.0-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.9 Linux/6.5.0-1018-azure

File hashes

Hashes for proto_kortex-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30572246cb71f397dc3acfbe5c88ae5de6f37fb2d11e552da42c54fc7ce776c2
MD5 e6cee3fbd7d61dd52218511575427e05
BLAKE2b-256 09d0d8091451300865700f3d45af6275f71713133cc3cd0771a9c28191586158

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