3
3
[ ![ Build Status] ( https://github.com/inorbit-ai/edge-sdk-python/workflows/Build%20Main/badge.svg )] ( https://github.com/inorbit-ai/edge-sdk-python/actions )
4
4
[ ![ Code Coverage] ( https://codecov.io/gh/inorbit/edge-sdk-python/branch/main/graph/badge.svg )] ( https://codecov.io/gh/inorbit/edge-sdk-python )
5
5
6
- The ` InOrbit Edge SDK ` allows Python programs to communicate with ` InOrbit ` platform on behalf of robots - providing robot data and handling robot actions. It's goal is to ease the integration between ` InOrbit ` and any other software that handles robot data.
6
+ | Python 3.8 | Python 3.9 | Python 3.10 | Python 3.11 |
7
+ | :-----------------------------------------------------------------------------------------------------------------------------------------:| :-----------------------------------------------------------------------------------------------------------------------------------------:| :------------------------------------------------------------------------------------------------------------------------------------------:| :-------------------------------------------------------------------------------------------------------------------------------------------:|
8
+ | ![ TeamCity] ( https://inorbit.teamcity.com/app/rest/builds/buildType:id:DeveloperPortal_EdgeSdkPython_Python38QualityRunner/statusIcon.svg ) | ![ TeamCity] ( https://inorbit.teamcity.com/app/rest/builds/buildType:id:DeveloperPortal_EdgeSdkPython_Python39QualityRunner/statusIcon.svg ) | ![ TeamCity] ( https://inorbit.teamcity.com/app/rest/builds/buildType:id:DeveloperPortal_EdgeSdkPython_Python310QualityRunner/statusIcon.svg ) | ![ TeamCity] ( https://inorbit.teamcity.com/app/rest/builds/buildType:id:DeveloperPortal_EdgeSdkPython_Python311QualityRunner/statusIcon.svg ) |
9
+
10
+ The ` InOrbit Edge SDK ` allows Python programs to communicate with ` InOrbit `
11
+ platform on behalf of robots - providing robot data and handling robot actions.
12
+ Its goal is to ease the integration between ` InOrbit ` and any other software
13
+ that handles robot data.
7
14
8
15
---
9
16
@@ -31,11 +38,11 @@ def my_command_handler(robot_id, command_name, args, options):
31
38
command_name (str): InOrbit command e.g. 'customCommand'
32
39
args (list): Command arguments
33
40
options (dict): object that includes
34
- - `result_function` can be called to report command execution result. It
35
- has the following signature: `result_function(return_code)`.
36
- - `progress_function` can be used to report command output and has the
37
- following signature: `progress_function(output, error)`.
38
- - `metadata` is reserved for the future and will contains additional
41
+ - `result_function` can be called to report command execution
42
+ result with the following signature: `result_function(return_code)`
43
+ - `progress_function` can be used to report command output with
44
+ the following signature: `progress_function(output, error)`
45
+ - `metadata` is reserved for the future and will contain additional
39
46
information about the received command request.
40
47
"""
41
48
if command_name == " customCommand" :
@@ -50,7 +57,7 @@ robot_session_factory = RobotSessionFactory(
50
57
51
58
# Register commands handlers. Note that all handlers are invoked.
52
59
robot_session_factory.register_command_callback(my_command_handler)
53
- robot_session_factory.register_executable_commands (" ./user_scripts" , r " . * \. sh" )
60
+ robot_session_factory.register_commands_path (" ./user_scripts" , r " . * \. sh" )
54
61
55
62
robot_session_pool = RobotSessionPool(robot_session_factory)
56
63
@@ -72,21 +79,22 @@ For full package documentation please visit [InOrbit Developer Portal](https://d
72
79
73
80
## Development
74
81
75
- See [ CONTRIBUTING.md] ( CONTRIBUTING.md ) for information related to developing the code.
82
+ See [ CONTRIBUTING.md] ( CONTRIBUTING.md ) for information related to developing
83
+ the code.
76
84
77
85
## The Three Commands You Need To Know
78
86
79
87
1 . ` pip install -e .[dev] `
80
88
81
- This will install your package in editable mode with all the required development
82
- dependencies (i.e. ` tox ` ).
89
+ This will install your package in editable mode with all the required
90
+ development dependencies (i.e. ` tox ` ).
83
91
84
92
2 . ` make build `
85
93
86
- This will run ` tox ` which will run all your tests in both Python 3.7
87
- and Python 3.8 as well as linting your code.
94
+ This will run ` tox ` which will run all your tests in Python 3.8 - 3.11 as
95
+ well as linting your code.
88
96
89
97
3 . ` make clean `
90
98
91
- This will clean up various Python and build generated files so that you can ensure
92
- that you are working in a clean environment.
99
+ This will clean up various Python and build generated files so that you can
100
+ ensure that you are working in a clean environment.
0 commit comments