diff --git a/README.md b/README.md
index 3cce849..b73d0c4 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,31 @@
# RemotiveLabs RemotiveBroker GRPC APIs
-This repo contains all public API from [RemotiveLabs](https://remotivelabs.com/) for integrating
-with RemotiveBroker using your favourite programming language.
+This repo contains all public API from [RemotiveLabs](https://remotivelabs.com/) for integrating with RemotiveBroker using your favourite
+programming language.
-We currently have pre-built GAPIC (Generated API Client) for python and grpc-web
-but will add more moving forward.
+We currently have pre-built GAPIC (Generated API Client) for a few languages, but will add more moving forward.
-For other languages visit https://grpc.io/ to read up how to generate code for your
-programming language based on our protocol buffer definition files
+For other languages visit https://grpc.io/ to read up how to generate code for your programming language based on our protocol buffer
+definition files.
## Protocol buffer definitions
Use these to generate GAPIC for your programming language.
-- [Documentation and source code](protos/)
+[Protobuf files](./protos/README.md)
-## Python RemotiveBroker API
+## Language specific APIs
-Pre-built Python GAPIC + some extra helper functions
-
-- [Documentation and source code](./python/remotivelabs-broker/)
-- [Code samples](https://github.com/remotivelabs/remotivelabs-samples/tree/main/python)
-
-## gRPC-web RemotiveBroker API
-
-Pre-built gRPC-web RemotiveBroker GAPIC. gRPC-web is designed to run in browser and
-not in nodejs. This is Javascipt+Typescript.
-
-- [Documentation and source code](grpc-web/grpc-web-stubs)
+- [Python](./python/remotivelabs-broker/)
+- [gRPC-web](./grpc-web/README.md)
+- [Rust](./rust/README.md)
## RemotiveBroker configuration schemas
[JSON schemas](schemas) of configuration files used by RemotiveBroker.
-## Coming soon
-
-Pre-built GAPIC for the following languages are coming shortly
-
-* Java and Kotlin
-* NodeJS
-
## Questions
-Please use our discussion forum/community for any questions you might have
+Please use our discussion forum/community for any questions you might have:
+
https://github.com/remotivelabs/remotivelabs-community/discussions
diff --git a/grpc-web/README.md b/grpc-web/README.md
index 57af5e4..2b23f74 100644
--- a/grpc-web/README.md
+++ b/grpc-web/README.md
@@ -1,26 +1,57 @@
-# RemotiveLabs WEB-GRPC
+# RemotiveBroker WEB-GRPC API
-Web-grpc is javascript to be used in a browser context, not intended
-to bu used with nodejs, read more here https://github.com/grpc/grpc-web
+`remotivelabs-grpc-web-stubs` - Javascript SDK for interacting with the RemotiveBroker API in a browser context. Not intended to be used
+with NodeJS.
-## Grpc-web-stubs
+Published to npm on [https://www.npmjs.com/package/remotivelabs-grpc-web-stubs](https://www.npmjs.com/package/remotivelabs-grpc-web-stubs).
-[](https://www.npmjs.com/package/remotivelabs-grpc-web-stubs)
+## Getting started
-Pre-built GRPC stubs generated from protobuf files
+```bash
+cd grpc-web/grpc-web-stubs
+# install dependencies
+yarn install
+
+# TODO
```
-npm install --save remotivelabs-grpc-web-stubs
-```
-or
-```
-yarn add remotivelabs-grpc-web-stubs
+
+## Building
+
+```bash
+cd grpc-web/grpc-web-stubs
+
+# Build docker image
+docker build -t remotivelabs/grpc-web-generator .
+
+# Generate typescript
+./generate-ts.sh
+
+# Generate javascript
+./generate-js.sh
```
-Read more: [grpc-web-stubs/](grpc-web-stubs/)
+## Versioning
-## Grpc-web-client
+Versioning is done using `npm version`, see [Publishing](#publishing).
-RemotiveBroker high-level client is coming soon. This API will be based on our
-RemotiveBrokerApp that is using the grpc-web-stubs but adds layer on top to make
-it simpler to use.
\ No newline at end of file
+Follow [Semantic versioning](https://semver.org/). Beta versions should be suffixed with `-beta*`, example `0.2.0-beta1`.
+
+## Publishing
+
+Published to npm on [https://www.npmjs.com/package/remotivelabs-grpc-web-stubs](https://www.npmjs.com/package/remotivelabs-grpc-web-stubs).
+
+```bash
+# generate stubs
+./generate-ts.sh
+
+# update version
+npm version x.y.z
+
+# commit version
+git add .
+git commit -m "release: Prepare a release for version x.y.z"
+
+# publish
+npm publish
+```
diff --git a/grpc-web/grpc-web-stubs/README.md b/grpc-web/grpc-web-stubs/README.md
index 7b5d22d..bed3cce 100644
--- a/grpc-web/grpc-web-stubs/README.md
+++ b/grpc-web/grpc-web-stubs/README.md
@@ -5,44 +5,35 @@
These are generated grpc-web stubs to be used in a browser context, not intended
to bu used with nodejs, read more here https://github.com/grpc/grpc-web
-## Usage
+## Installation
-### Installation
-```
-npm install --save remotivelabs-grpc-web-stubs
+```bash
+yarn install --save remotivelabs-grpc-web-stubs
```
+
or
-```
+
+```bash
yarn add remotivelabs-grpc-web-stubs
```
-### Import
-```
+## Usage
+
+```javascript
import {SystemServiceClient} from 'remotivelabs-grpc-web-stubs'
const client = new SystemServiceClient(brokerUrl)
```
-## Development
-
-### Build grpc-web-generator
+## Examples
-This image is on dockerhub so you do not have to build it
-```sh
-docker build -t remotivelabs/grpc-web-generator .
-```
-
-### Generate stubs
+See [examples](./examples/README.md)
-From this directory run the following commands and update `src/index.ts` to explicitly export types.
+## License
-```sh
-sh ./generate-ts.sh
-```
+`remotivelabs-grpc-web-stubs` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
-## Release Instructions
+## Documentation
-1. Commit changes.
-2. Generate stubs `sh ./generate-ts.sh`.
-3. Update version with `npm version x.y.z` and commit it with `release: Prepare a release for version x.y.z`.
-4. Publish with `npm publish`.
+TODO: We dont have any documentation
+See [https://docs.remotivelabs.com/apis/python/remotivelabs/broker](https://docs.remotivelabs.com/apis/python/remotivelabs/broker).
diff --git a/grpc-web/grpc-web-stubs/examples/README.md b/grpc-web/grpc-web-stubs/examples/README.md
new file mode 100644
index 0000000..4f2254e
--- /dev/null
+++ b/grpc-web/grpc-web-stubs/examples/README.md
@@ -0,0 +1 @@
+# `remotivelabs-grpc-web-stubs` examples
diff --git a/python/README.md b/python/README.md
index f94f0c1..ca3c963 100644
--- a/python/README.md
+++ b/python/README.md
@@ -1,8 +1,8 @@
-# RemotiveLabs Broker API Python SDK
+# RemotiveBroker Python API
-`remotivelabs-broker` - Python SDK for interacting with the RemotiveLabs Broker.
+`remotivelabs-broker` - Python SDK for interacting with the RemotiveBroker API.
-Published to PyPI on [https://pypi.org/project/remotivelabs-broker/](https://pypi.org/project/remotivelabs-broker/)
+Published to PyPI on [https://pypi.org/project/remotivelabs-broker/](https://pypi.org/project/remotivelabs-broker/).
## Getting started
@@ -49,7 +49,7 @@ Building the complete package, including protobuf stubs and documentation, is do
Update the package version by editing the following `pyproject.toml` file.
-Follow [Semantic versioning](https://semver.org/). Beta versions should be suffixed with `b*`, example `0.2.0b1`.
+Follow [Semantic versioning](https://semver.org/). Beta versions should be suffixed with `-beta*`, example `0.2.0-beta1`.
## Publishing
diff --git a/python/remotivelabs-broker/.pylintrc b/python/remotivelabs-broker/.pylintrc
deleted file mode 100644
index 1d2ae19..0000000
--- a/python/remotivelabs-broker/.pylintrc
+++ /dev/null
@@ -1,640 +0,0 @@
-[MAIN]
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Clear in-memory caches upon conclusion of linting. Useful if running pylint
-# in a server-like mode.
-clear-cache-post-run=no
-
-# Load and enable all available extensions. Use --list-extensions to see a list
-# all available extensions.
-#enable-all-extensions=
-
-# In error mode, messages with a category besides ERROR or FATAL are
-# suppressed, and no reports are done by default. Error mode is compatible with
-# disabling specific errors.
-#errors-only=
-
-# Always return a 0 (non-error) status code, even if lint errors are found.
-# This is primarily useful in continuous integration scripts.
-#exit-zero=
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code.
-extension-pkg-allow-list=
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
-# for backward compatibility.)
-extension-pkg-whitelist=
-
-# Return non-zero exit code if any of these messages/categories are detected,
-# even if score is above --fail-under value. Syntax same as enable. Messages
-# specified are enabled, while categories only check already-enabled messages.
-fail-on=
-
-# Specify a score threshold under which the program will exit with error.
-fail-under=10
-
-# Interpret the stdin as a python script, whose filename needs to be passed as
-# the module_or_package argument.
-#from-stdin=
-
-# Files or directories to be skipped. They should be base names, not paths.
-ignore=CVS
-
-# Add files or directories matching the regular expressions patterns to the
-# ignore-list. The regex matches against paths and can be in Posix or Windows
-# format. Because '\\' represents the directory delimiter on Windows systems,
-# it can't be used as an escape character.
-ignore-paths=
-
-# Files or directories matching the regular expression patterns are skipped.
-# The regex matches against base names, not paths. The default value ignores
-# Emacs file locks
-ignore-patterns=\..*
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis). It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
-# number of processors available to use, and will cap the count on Windows to
-# avoid hangs.
-jobs=1
-
-# Control the amount of potential inferred values when inferring a single
-# object. This can help the performance when dealing with large functions or
-# complex, nested conditions.
-limit-inference-results=100
-
-# List of plugins (as comma separated values of python module names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# Minimum Python version to use for version dependent checks. Will default to
-# the version used to run pylint.
-py-version=3.8
-
-# Discover python modules and packages in the file system subtree.
-recursive=no
-
-# Add paths to the list of the source roots. Supports globbing patterns. The
-# source root is an absolute path or a path relative to the current working
-# directory used to determine a package namespace for modules located under the
-# source root.
-source-roots=
-
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-# In verbose mode, extra non-checker-related info will be displayed.
-#verbose=
-
-
-[BASIC]
-
-# Naming style matching correct argument names.
-argument-naming-style=snake_case
-
-# Regular expression matching correct argument names. Overrides argument-
-# naming-style. If left empty, argument names will be checked with the set
-# naming style.
-#argument-rgx=
-
-# Naming style matching correct attribute names.
-attr-naming-style=snake_case
-
-# Regular expression matching correct attribute names. Overrides attr-naming-
-# style. If left empty, attribute names will be checked with the set naming
-# style.
-#attr-rgx=
-
-# Bad variable names which should always be refused, separated by a comma.
-bad-names=foo,
- bar,
- baz,
- toto,
- tutu,
- tata
-
-# Bad variable names regexes, separated by a comma. If names match any regex,
-# they will always be refused
-bad-names-rgxs=
-
-# Naming style matching correct class attribute names.
-class-attribute-naming-style=any
-
-# Regular expression matching correct class attribute names. Overrides class-
-# attribute-naming-style. If left empty, class attribute names will be checked
-# with the set naming style.
-#class-attribute-rgx=
-
-# Naming style matching correct class constant names.
-class-const-naming-style=UPPER_CASE
-
-# Regular expression matching correct class constant names. Overrides class-
-# const-naming-style. If left empty, class constant names will be checked with
-# the set naming style.
-#class-const-rgx=
-
-# Naming style matching correct class names.
-class-naming-style=PascalCase
-
-# Regular expression matching correct class names. Overrides class-naming-
-# style. If left empty, class names will be checked with the set naming style.
-#class-rgx=
-
-# Naming style matching correct constant names.
-const-naming-style=UPPER_CASE
-
-# Regular expression matching correct constant names. Overrides const-naming-
-# style. If left empty, constant names will be checked with the set naming
-# style.
-#const-rgx=
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-# Naming style matching correct function names.
-function-naming-style=snake_case
-
-# Regular expression matching correct function names. Overrides function-
-# naming-style. If left empty, function names will be checked with the set
-# naming style.
-#function-rgx=
-
-# Good variable names which should always be accepted, separated by a comma.
-good-names=i,
- j,
- k,
- ex,
- Run,
- _
-
-# Good variable names regexes, separated by a comma. If names match any regex,
-# they will always be accepted
-good-names-rgxs=
-
-# Include a hint for the correct naming format with invalid-name.
-include-naming-hint=no
-
-# Naming style matching correct inline iteration names.
-inlinevar-naming-style=any
-
-# Regular expression matching correct inline iteration names. Overrides
-# inlinevar-naming-style. If left empty, inline iteration names will be checked
-# with the set naming style.
-#inlinevar-rgx=
-
-# Naming style matching correct method names.
-method-naming-style=snake_case
-
-# Regular expression matching correct method names. Overrides method-naming-
-# style. If left empty, method names will be checked with the set naming style.
-#method-rgx=
-
-# Naming style matching correct module names.
-module-naming-style=snake_case
-
-# Regular expression matching correct module names. Overrides module-naming-
-# style. If left empty, module names will be checked with the set naming style.
-#module-rgx=
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# List of decorators that produce properties, such as abc.abstractproperty. Add
-# to this list to register other decorators that produce valid properties.
-# These decorators are taken in consideration only for invalid-name.
-property-classes=abc.abstractproperty
-
-# Regular expression matching correct type alias names. If left empty, type
-# alias names will be checked with the set naming style.
-#typealias-rgx=
-
-# Regular expression matching correct type variable names. If left empty, type
-# variable names will be checked with the set naming style.
-#typevar-rgx=
-
-# Naming style matching correct variable names.
-variable-naming-style=snake_case
-
-# Regular expression matching correct variable names. Overrides variable-
-# naming-style. If left empty, variable names will be checked with the set
-# naming style.
-#variable-rgx=
-
-
-[CLASSES]
-
-# Warn about protected attribute access inside special methods
-check-protected-access-in-special-methods=no
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,
- __new__,
- setUp,
- asyncSetUp,
- __post_init__
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-
-[DESIGN]
-
-# List of regular expressions of class ancestor names to ignore when counting
-# public methods (see R0903)
-exclude-too-few-public-methods=
-
-# List of qualified class names to ignore when counting class parents (see
-# R0901)
-ignored-parents=
-
-# Maximum number of arguments for function / method.
-max-args=7
-
-# Maximum number of attributes for a class (see R0902).
-max-attributes=10
-
-# Maximum number of boolean expressions in an if statement (see R0916).
-max-bool-expr=5
-
-# Maximum number of branch for function / method body.
-max-branches=12
-
-# Maximum number of locals for function / method body.
-max-locals=15
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of return / yield for function / method body.
-max-returns=6
-
-# Maximum number of statements in function / method body.
-max-statements=50
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when caught.
-overgeneral-exceptions=builtins.BaseException,builtins.Exception
-
-
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-expected-line-ending-format=
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )??$
-
-# Number of spaces of indent required inside a hanging or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
-# tab).
-indent-string=' '
-
-# Maximum number of characters on a single line.
-max-line-length=140
-
-# Maximum number of lines in a module.
-max-module-lines=1000
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[IMPORTS]
-
-# List of modules that can be imported at any level, not just the top level
-# one.
-allow-any-import-level=
-
-# Allow explicit reexports by alias from a package __init__.
-allow-reexport-from-package=no
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Deprecated modules which should not be used, separated by a comma.
-deprecated-modules=
-
-# Output a graph (.gv or any supported image format) of external dependencies
-# to the given file (report RP0402 must not be disabled).
-ext-import-graph=
-
-# Output a graph (.gv or any supported image format) of all (i.e. internal and
-# external) dependencies to the given file (report RP0402 must not be
-# disabled).
-import-graph=
-
-# Output a graph (.gv or any supported image format) of internal dependencies
-# to the given file (report RP0402 must not be disabled).
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-# Couples of modules and preferred modules, separated by a comma.
-preferred-modules=
-
-
-[LOGGING]
-
-# The type of string formatting that logging methods do. `old` means using %
-# formatting, `new` is for `{}` formatting.
-logging-format-style=old
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format.
-logging-modules=logging
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
-# UNDEFINED.
-confidence=HIGH,
- CONTROL_FLOW,
- INFERENCE,
- INFERENCE_FAILURE,
- UNDEFINED
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once). You can also use "--disable=all" to
-# disable everything first and then re-enable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use "--disable=all --enable=classes
-# --disable=W".
-disable=raw-checker-failed,
- bad-inline-option,
- locally-disabled,
- file-ignored,
- suppressed-message,
- useless-suppression,
- deprecated-pragma,
- use-symbolic-message-instead,
- use-implicit-booleaness-not-comparison-to-string,
- use-implicit-booleaness-not-comparison-to-zero,
- missing-function-docstring,
- missing-class-docstring,
- missing-module-docstring,
- logging-fstring-interpolation,
- broad-exception-raised,
- too-few-public-methods
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once). See also the "--disable" option for examples.
-enable=
-
-
-[METHOD_ARGS]
-
-# List of qualified names (i.e., library.method) which require a timeout
-# parameter e.g. 'requests.api.get,requests.api.post'
-timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,
- XXX,
- TODO
-
-# Regular expression of note tags to take in consideration.
-notes-rgx=
-
-
-[REFACTORING]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-# Complete name of functions that never returns. When checking for
-# inconsistent-return-statements if a never returning function is called then
-# it will be considered as an explicit return statement and no message will be
-# printed.
-never-returning-functions=sys.exit,argparse.parse_error
-
-
-[REPORTS]
-
-# Python expression which should return a score less than or equal to 10. You
-# have access to the variables 'fatal', 'error', 'warning', 'refactor',
-# 'convention', and 'info' which contain the number of messages in each
-# category, as well as 'statement' which is the total number of statements
-# analyzed. This score is used by the global evaluation report (RP0004).
-evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details.
-msg-template=
-
-# Set the output format. Available formats are: text, parseable, colorized,
-# json2 (improved json format), json (old json format) and msvs (visual
-# studio). You can also give a reporter class, e.g.
-# mypackage.mymodule.MyReporterClass.
-#output-format=
-
-# Tells whether to display a full report or only the messages.
-reports=no
-
-# Activate the evaluation score.
-score=yes
-
-
-[SIMILARITIES]
-
-# Comments are removed from the similarity computation
-ignore-comments=yes
-
-# Docstrings are removed from the similarity computation
-ignore-docstrings=yes
-
-# Imports are removed from the similarity computation
-ignore-imports=yes
-
-# Signatures are removed from the similarity computation
-ignore-signatures=yes
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-
-[SPELLING]
-
-# Limits count of emitted suggestions for spelling mistakes.
-max-spelling-suggestions=4
-
-# Spelling dictionary name. No available dictionaries : You need to install
-# both the python package and the system dependency for enchant to work.
-spelling-dict=
-
-# List of comma separated words that should be considered directives if they
-# appear at the beginning of a comment and should not be checked.
-spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains the private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to the private dictionary (see the
-# --spelling-private-dict-file option) instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[STRING]
-
-# This flag controls whether inconsistent-quotes generates a warning when the
-# character used as a quote delimiter is used inconsistently within a module.
-check-quote-consistency=no
-
-# This flag controls whether the implicit-str-concat should generate a warning
-# on implicit string concatenation in sequences defined over several lines.
-check-str-concat-over-line-jumps=no
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether to warn about missing members when the owner of the attribute
-# is inferred to be None.
-ignore-none=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of symbolic message names to ignore for Mixin members.
-ignored-checks-for-mixins=no-member,
- not-async-context-manager,
- not-context-manager,
- attribute-defined-outside-init
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace
-
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
-
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
-
-# Regex pattern to define which classes are considered mixins.
-mixin-class-rgx=.*[Mm]ixin
-
-# List of decorators that change the signature of a decorated function.
-signature-mutators=
-
-
-[VARIABLES]
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid defining new builtins when possible.
-additional-builtins=
-
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
-
-# List of names allowed to shadow builtins
-allowed-redefined-builtins=
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,
- _cb
-
-# A regular expression matching the name of dummy variables (i.e. expected to
-# not be used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
-
-# Argument names that match this expression will be ignored.
-ignored-argument-names=_.*|^ignored_|^unused_
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
diff --git a/python/remotivelabs-broker/README.md b/python/remotivelabs-broker/README.md
index 0c697de..a58cd72 100644
--- a/python/remotivelabs-broker/README.md
+++ b/python/remotivelabs-broker/README.md
@@ -1,29 +1,27 @@
-# RemotiveLabs Broker
+# RemotiveLabs Broker API
[](https://pypi.org/project/remotivelabs-broker)
[](https://pypi.org/project/remotivelabs-broker)
-- [Link to **Samples**](https://github.com/remotivelabs/remotivelabs-samples/tree/main/python).
-- [Link to **Documentation**](https://docs.remotivelabs.com/apis/python/remotivelabs/broker).
-
------
-
-**Table of Contents**
-
-- [Installation](#installation)
-- [Examples](#examples)
-- [License](#license)
+`remotivelabs-broker` is a simple library for interfacing with the [RemotiveBroker](https://docs.remotivelabs.com/docs/remotive-broker).
## Installation
Install into your Python environment with _PIP_:
- pip install remotivelabs-broker
+```bash
+pip install remotivelabs-broker
+```
## Examples
-Examples using this library are found in the [Remotive Labs samples repository](https://github.com/remotivelabs/remotivelabs-samples).
+See [examples](./examples/README.md)
## License
`remotivelabs-broker` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
+
+
+## Documentation
+
+See [https://docs.remotivelabs.com/apis/python/remotivelabs/broker](https://docs.remotivelabs.com/apis/python/remotivelabs/broker).
diff --git a/python/remotivelabs-broker/examples/README.md b/python/remotivelabs-broker/examples/README.md
new file mode 100644
index 0000000..d090dd0
--- /dev/null
+++ b/python/remotivelabs-broker/examples/README.md
@@ -0,0 +1 @@
+# `remotivelabs-broker` examples
diff --git a/python/remotivelabs-broker/pyproject.toml b/python/remotivelabs-broker/pyproject.toml
index c0cbcb2..8013896 100644
--- a/python/remotivelabs-broker/pyproject.toml
+++ b/python/remotivelabs-broker/pyproject.toml
@@ -1,7 +1,7 @@
[tool.poetry]
name = "remotivelabs-broker"
description = 'RemotiveLabs Broker gRPC API'
-version = "0.2.0"
+version = "0.2.0-beta1"
readme = "README.md"
license = "Apache-2.0"
homepage = "https://remotivelabs.com/"
diff --git a/rust/README.md b/rust/README.md
new file mode 100644
index 0000000..6638287
--- /dev/null
+++ b/rust/README.md
@@ -0,0 +1,28 @@
+# RemotiveBroker Rust API
+
+`remotivelabs-broker` - Rust library with gRPC-bindings and utility functions.
+
+## Getting started
+
+```bash
+cd rust/remotivelabs-broker
+
+# build
+cargo build
+```
+
+## Building
+
+```bash
+cd rust/remotivelabs-broker
+
+cargo build
+```
+
+## Versioning
+
+Follow [Semantic versioning](https://semver.org/). Beta versions should be suffixed with `-beta*`, example `0.2.0-beta1`.
+
+## Publishing
+
+This library is not published.
diff --git a/rust/remotivelabs-broker/Cargo.toml b/rust/remotivelabs-broker/Cargo.toml
index b8bc305..fa2f2f6 100644
--- a/rust/remotivelabs-broker/Cargo.toml
+++ b/rust/remotivelabs-broker/Cargo.toml
@@ -1,7 +1,7 @@
[package]
-name = "remotive-broker"
+name = "remotivelabs-broker"
version = "0.1.0"
-authors = [ "RemotiveLabs support ", "Lind, Niclas "]
+authors = ["RemotiveLabs support "]
edition = "2021"
[dependencies]
@@ -9,7 +9,13 @@ futures = "0.3.19"
path-slash = "0.1.4"
prost = "0.9.0"
sha2 = "0.10.1"
-tokio = { version = "1.14.0", features = ["rt-multi-thread", "time", "fs", "macros", "net"] }
+tokio = { version = "1.14.0", features = [
+ "rt-multi-thread",
+ "time",
+ "fs",
+ "macros",
+ "net",
+] }
tonic = { version = "0.6.2", features = ["tls", "tls-roots"] }
walkdir = "2.3.2"
diff --git a/rust/remotivelabs-broker/README.md b/rust/remotivelabs-broker/README.md
index 99a5f21..ddb3fdf 100644
--- a/rust/remotivelabs-broker/README.md
+++ b/rust/remotivelabs-broker/README.md
@@ -1,9 +1,24 @@
-# RemotiveLabs Broker
+# RemotiveBroker Rust API
+
Rust library with gRPC-bindings and utility functions.
-gRPC bindings are generated from [this source](../../proto/) when compiling the project.
+## Usage
+
+```rust
+use remotive_broker::{
+ Connection,
+};
+
+#[tokio::main]
+async fn main() -> Result<(), Box> {
+ let mut con = Connection::new("http://localhost:50051".to_string(), None).await?;
+
+ println!("Checking license...");
+ con.check_license().await?;
-This project is contributed by _Niclas Lind_ (@niclaslind).
+ Ok(())
+}
+```
## Examples
diff --git a/rust/remotivelabs-broker/examples/README.md b/rust/remotivelabs-broker/examples/README.md
new file mode 100644
index 0000000..d090dd0
--- /dev/null
+++ b/rust/remotivelabs-broker/examples/README.md
@@ -0,0 +1 @@
+# `remotivelabs-broker` examples