File: README.md

package info (click to toggle)
swupdate 2025.12%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 10,004 kB
  • sloc: ansic: 66,621; python: 6,291; makefile: 791; sh: 538; javascript: 229
file content (48 lines) | stat: -rw-r--r-- 679 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<!--
SPDX-FileCopyrightText: 2021 Blueye Robotics AS

SPDX-License-Identifier: GPL-2.0-only
-->

## Installing swupdateclient

### pip
```
cd tools/python/swupdateclient
pip3 install .
```

### pipenv
```
pipenv install
```

## Usage

### pip
```
swupdateclient <path-to-swu> <host_name> [port] [path]
```

### pipenv
```
pipenv run swupdateclient <path-to-swu> <host_name> [port] [path]
```


## Development
### Import from another python program
```
from swupdateclient.main import SWUpdater

updater = SWUpdater("path-to-swu", "host-name")
if updater.update():
    print("Update successful!")
else:
    print("Update failed!")
```

### Formatting
```
black swupdateclient
```