Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 2.42 KB

README.md

File metadata and controls

84 lines (58 loc) · 2.42 KB
Raw

Simple Management Protocol (SMP)

smp implements serialization and deserialization of the Simple Management Protocol.

The SMP specification can be found here.

If you'd like a library that implements the serial (UART or USB), Bluetooth (BLE), and UDP transport layers for SMP, take a look at smpclient.

If you need an SMP CLI application to interact with device firmware, then try smpmgr.

Install

smp is distributed by PyPI and can be installed with poetry, pip, and other dependency managers.

User Documentation

Documentation is in the source code so that it is available to your editor. An online version is generated and available here.

Development Quickstart

Assumes that you've already setup your development environment.

  1. activate envr, the environment manager for bash, zsh, and PS: 
    . ./envr.ps1
  2. run poetry install when pulling in new changes
  3. run lint after making changes
  4. run test after making changes
  5. add library dependencies with poetry: 
    poetry add <my_new_dependency>
  6. add test or other development dependencies using poetry groups: 
    poetry add -G dev <my_dev_dependency>
  7. run tests for all supported python versions:
tox

Development Environment Setup

Install Dependencies

Create the venv

poetry install

The venv should be installed to .venv.

Activate envr

envr supports bash, zsh, and PS in Linux, MacOS, and Windows. If you are using an unsupported shell, you can activate the .venv environment manually, use poetry run and poetry shell, and refer to envr-default for useful aliases.

. ./envr.ps1

Verify Your Setup

To verify the installation, make sure that all of the tests are passing using these envr aliases:

lint
test

Enable the githooks

The pre-commit hook will run the linters but not the unit tests.

git config core.hooksPath .githooks