Skip to content

Latest commit

 

History

History
119 lines (89 loc) · 3.57 KB

README.md

File metadata and controls

119 lines (89 loc) · 3.57 KB

iotics-grpc-client-rs

Crates Crates.io CI dependency status license
IOTICS gRPC client in Rust.

Usage and Version Compatibility with Iotics host

iotics-grpc-client-rs iotics-host
iotics-grpc-client = "7.x.x" >= 7
iotics-grpc-client = "6.x.x" >= 7
iotics-grpc-client = "5.x.x" >= 6
iotics-grpc-client = "4.x.x" >= 6
iotics-grpc-client = "3.x.x" >= 5
iotics-grpc-client = "2.x.x" >= 5
iotics-grpc-client = "0.3.x" >= 4

API Docs

Running the examples

Rename .env-sample to .env and give values to the environment variables.

git clone --recurse-submodules [email protected]:Iotic-Labs/iotics-grpc-client-rs.git
cargo run --features tls --example search

Contributing

Proto files

Incrementing the API version

Run

cd api
git fetch --all --tags
git checkout tags/vX.X.X
cd ..
git add api

git commit -m "Updated api to vX.X.X"
git push

Updating the API version

git submodule update --remote

Building

You will need to ensure you have the appropriate packages installed on your system to compile protobuf. On Ubuntu systems, for example:

sudo apt install protobuf-compiler libprotobuf-dev

PRs

Commands to run before creating a PR

cargo make format
cargo make clippy

Should contain a summary of the changes in CHANGELOG.md under the Unreleased section.

Releasing

    git push
    git tag -a vX.X.X -m "vX.X.X"
    git push origin vX.X.X

OSS Review

  cargo install cargo-license
  cargo license -t --avoid-build-deps --avoid-dev-deps --direct-deps-only