Skip to content

Commit 25637b6

Browse files
Merge pull request #38 from inorbit-ai/config/teamcity-badges
Adds TeamCity build badges and minor cleanup of README.md
2 parents b430078 + ba000f6 commit 25637b6

File tree

5 files changed

+27
-63
lines changed

5 files changed

+27
-63
lines changed

.github/workflows/build-main.yml

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
runs-on: ${{ matrix.os }}
1616
strategy:
1717
matrix:
18-
python-version: [3.8, 3.9, 3.10, 3.11]
18+
python-version: ['3.8', '3.9', '3.10', '3.11']
1919
os: [windows-latest, macOS-latest]
2020

2121
steps:
@@ -34,26 +34,6 @@ jobs:
3434
- name: Upload codecov
3535
uses: codecov/codecov-action@v1
3636

37-
lint:
38-
runs-on: ubuntu-latest
39-
40-
steps:
41-
- uses: actions/checkout@v1
42-
- name: Set up Python
43-
uses: actions/setup-python@v1
44-
with:
45-
python-version: 3.9
46-
- name: Install Dependencies
47-
run: |
48-
python -m pip install --upgrade pip
49-
pip install .[test]
50-
- name: Lint with flake8
51-
run: |
52-
flake8 inorbit_edge --count --verbose --show-source --statistics
53-
- name: Check with black
54-
run: |
55-
black --check inorbit_edge --exclude inorbit_edge/inorbit_pb2.py
56-
5737
publish:
5838
if: "contains(github.event.head_commit.message, 'Bump version')"
5939
needs: [test, lint]
@@ -64,7 +44,7 @@ jobs:
6444
- name: Set up Python
6545
uses: actions/setup-python@v1
6646
with:
67-
python-version: 3.9
47+
python-version: '3.10'
6848
- name: Install Dependencies
6949
run: |
7050
python -m pip install --upgrade pip

.github/workflows/test-and-lint.yml

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ jobs:
77
runs-on: ${{ matrix.os }}
88
strategy:
99
matrix:
10-
python-version: [3.7, 3.8, 3.9]
11-
os: [ubuntu-latest, windows-latest, macOS-latest]
10+
python-version: ['3.8', '3.9', '3.10', '3.11']
11+
os: [windows-latest, macOS-latest]
1212

1313
steps:
1414
- uses: actions/checkout@v1
@@ -25,23 +25,3 @@ jobs:
2525
pytest inorbit_edge/tests/
2626
- name: Upload codecov
2727
uses: codecov/codecov-action@v1
28-
29-
lint:
30-
runs-on: ubuntu-latest
31-
32-
steps:
33-
- uses: actions/checkout@v1
34-
- name: Set up Python
35-
uses: actions/setup-python@v1
36-
with:
37-
python-version: 3.9
38-
- name: Install Dependencies
39-
run: |
40-
python -m pip install --upgrade pip
41-
pip install .[test]
42-
- name: Lint with flake8
43-
run: |
44-
flake8 inorbit_edge --count --verbose --show-source --statistics
45-
- name: Check with black
46-
run: |
47-
black --diff --check inorbit_edge --exclude inorbit_edge/inorbit_pb2.py

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,5 @@ ENV/
105105
.vscode
106106

107107
# IntelliJ
108+
.idea/
108109
*.iml

.idea/.gitignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@
33
[![Build Status](https://github.com/inorbit-ai/edge-sdk-python/workflows/Build%20Main/badge.svg)](https://github.com/inorbit-ai/edge-sdk-python/actions)
44
[![Code Coverage](https://codecov.io/gh/inorbit/edge-sdk-python/branch/main/graph/badge.svg)](https://codecov.io/gh/inorbit/edge-sdk-python)
55

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.
714

815
---
916

@@ -31,11 +38,11 @@ def my_command_handler(robot_id, command_name, args, options):
3138
command_name (str): InOrbit command e.g. 'customCommand'
3239
args (list): Command arguments
3340
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
3946
information about the received command request.
4047
"""
4148
if command_name == "customCommand":
@@ -50,7 +57,7 @@ robot_session_factory = RobotSessionFactory(
5057

5158
# Register commands handlers. Note that all handlers are invoked.
5259
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")
5461

5562
robot_session_pool = RobotSessionPool(robot_session_factory)
5663

@@ -72,21 +79,22 @@ For full package documentation please visit [InOrbit Developer Portal](https://d
7279

7380
## Development
7481

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.
7684

7785
## The Three Commands You Need To Know
7886

7987
1. `pip install -e .[dev]`
8088

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`).
8391

8492
2. `make build`
8593

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.
8896

8997
3. `make clean`
9098

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

Comments
 (0)