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

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-2.3.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.3.0.tar.gz
Algorithm Hash digest
SHA256 66fe18c5c4502d9c8cf4f7db8f5b05c21312e99f2d2bcf4e8a3f25975a1729d3
MD5 92cf94f0b85657674c0b959f3f3e1f75
BLAKE2b-256 679250575066ae4399df57eb4a2acf609eecd46f4f4d40072c0d5224f75de62f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-2.3.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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 29541cde99c20d99e310ee11df6c9688437f6ae7b9b65f534e277f1b0c9c367d
MD5 c08d520eef3f172bba4145f676c070cb
BLAKE2b-256 9f82af690232f11d65e7f2c6f497723c518b92b0da40b16f282cb260afe6b914

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