iotics-grpc-client 2.0.1

Iotics gRPC client library

Iotics gRPC Python Client

A Python library for interacting with Iotics API.

Usage and Version Compatibility with Iotics host:

iotics-grpc-client-py	iotics-host
pip install iotics-grpc-client~=2.0	>= 5
pip install iotics-grpc-client~=0.10.0	>= 4

Examples

Configuring identity

To run examples, either set up required environment variables or create an .env file with the following values. For more information on the meaning of these values and how to create them, consult https://docs.iotics.com/docs/identity-api-and-credentials

• Required:

  • SPACE - Domain name of the IOTICSpace with which to communicate. The scheme can be omitted, eg. examplecorp. iotics.space
  • USER_SEED - secret value used to (re)create user public and private keys.
  • AGENT_SEED - secret value used to (re)create agent public and private keys.

• Optional:

  • DID_RESOLVER_URL - Where the database of identity documents is accesible, defaults to the one used by the given space.
  • USER_KEY_NAME - secret value used to (re)create multiple key pairs, defaults to empty.
  • USER_NAME - used to create/identify public keys, defaults to #user-0.
  • AGENT_KEY_NAME - secret value used to (re)create multiple key pairs, defaults to empty.
  • AGENT_NAME - registered identity name that can be used to e.g. identify public keys, defaults to #agent-0.

Running example scripts

Next, create and activate your virtual environment and run any of the scripts in the examples directory, e.g.:

make deps-py
. env/bin/activate
python examples/search_twin_models.py

Contributing

Installing dependencies and generating gRPC client

• To satisfy all dependencies, lint proto files and regenerate client files (inside a Docker container):

  make build
  

  • To generate gRPC Python files outside a Docker container the following command can be used: make generate. Currently, there is no official binary for Python gRPC plugin, but there is one built from the official repository inside the docker (the following will work on Linux machines):

    docker run --rm -dit --name iotics-grpc-client-py-builder iotics-grpc-client-py-builder /bin/bash
    docker cp iotics-grpc-client-py-builder:/bin/protoc-gen-python_grpc env/bin/protoc-gen-python_grpc
    docker stop iotics-grpc-client-py-builder
    make generate
    

• To update the Iotics API version and regenerate client
  (proto files are submoduled in ./iotics-api.git/ from Iotics API repo):

  _ver=vX.X.X
  make GIT_TAG=$_ver deps-proto-update build
  # Address usages of the new client in `src`, update "Unreleased" section in CHANGELOG.md, then:
  git add CHANGELOG.md iotics-api.git src
  git commit -m "Update Iotics API to $_ver"
  # Push your branch and create a PR
  

• Other make commands:
  • clean - remove artifacts created inside the project.
  • deps-* - install specific requirements if missing.
  • deps-*-update - update specific requirements when applicable.

PRs

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

Versioning

This package adheres to Semantic Versioning

Releasing

• Update package version in setup.py for the release:
• Update CHANGELOG.md (move notes from unreleased section, ensure right tags are used, etc.) and any other files as needed.
• Commit changes and create a PR.
• Once PR is merged manually run the Create Draft Release GitHub Action, this will create a tag with the version in setup.py and create a draft release in releases.
• Update the release's information and press the publish button on the release to publish it.
• The Publish GitHub Action will create a package and will publish it to PyPI.

License

Copyright © 2022 IOTIC LABS LTD. [e-mail]. All rights reserved. Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.