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

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-1.11.7.tar.gz
  • Upload date:
  • Size: 9.2 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.7.tar.gz
Algorithm Hash digest
SHA256 ec66e857ce24b4d05378445a99e4d67bfb7ea1ff96c29eb496db95c4edf06e96
MD5 7569bbd1e13b1953edbffc1ddc33d01a
BLAKE2b-256 5abe9abcfa7a6ac6637e41294594bbaf6073f2b901060d904cdc941b09081176

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-1.11.7-py3-none-any.whl
  • Upload date:
  • Size: 10.1 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 20c2014b8cabc8fe262deb4ecac9d7320e2363e856990c984c209109f6face4d
MD5 1ebaf6eac808de02f23ff042b8830dab
BLAKE2b-256 5f48a974b3f896769e43dd075481d1a617a2463df6991de9b9e9a578766fed79

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