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

Uploaded Python 3

File details

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

File metadata

  • Download URL: proto_kortex-2.0.1.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.0.1.tar.gz
Algorithm Hash digest
SHA256 1ae37abbb88dee3f499cd5537a42390617c27dab13b21c8440980ceaba980552
MD5 c8c5874ffb77b30e6f0f85c2cedb34a7
BLAKE2b-256 5b85f9d22d64d90e279968eac2f9b6905db335f852b41d0acd8916061fe0c14d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: proto_kortex-2.0.1-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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2d4dc7cc7aaf1be6e2988f05bfa538d7b6fb38c46afd17cfac1499d41006ada4
MD5 a993e02f9d838124aa10d643bd29053a
BLAKE2b-256 945224bb9f1e4adb8ea8fb869cf6f3365be779dc3359e08ab4ef17d3425cafbb

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