README.md

iotics-grpc-client-rs

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

• Are submoduled in api/ from https://github.com/Iotic-Labs/api.
• proto/google/rpc/status.proto is included as it's a dependency.

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

• Increment the version in Cargo.toml
• Update README.md and CHANGELOG.md as needed
• Commit
• Tag the commit and push the changes to main

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

• Release
  Create a new release containing the relevant change log.
  The publish.yaml GitHub Action will pick it up and do the actual release to crates.io.

OSS Review

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