# Simple Management Protocol (SMP)
`smp` implements serialization and deserialization of the Simple Management Protocol.
The SMP specification can be found [here](https://docs.zephyrproject.org/latest/services/device_mgmt/smp_protocol.html).
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](https://github.com/intercreate/smpclient).
If you need an SMP CLI application to interact with device firmware, then try
[smpmgr](https://github.com/intercreate/smpmgr).
## Install
`smp` is [distributed by PyPI](https://pypi.org/project/smp/) 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](https://jphutchins.github.io/smp/).
## Development Quickstart
> Assumes that you've already [setup your development environment](#development-environment-setup).
1. activate [envr](https://github.com/JPhutchins/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](https://python-poetry.org/docs/managing-dependencies#dependency-groups):
```
poetry add -G dev <my_dev_dependency>
```
7. run tests for all supported python versions:
```
tox
```
## Development Environment Setup
### Install Dependencies
- poetry==1.8.5: https://python-poetry.org/docs/#installation
### Create the venv
```
poetry install
```
The `venv` should be installed to `.venv`.
### Activate envr
> [envr](https://github.com/JPhutchins/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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/JPHutchins/smp",
"name": "smp",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "J.P. Hutchins",
"author_email": "jphutchins@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/eb/e8/b8db6f8786774f0219bdf354aee675b89d2e0a717c2b8f490d33a0f1d7ec/smp-3.3.1.tar.gz",
"platform": null,
"description": "# Simple Management Protocol (SMP)\n\n`smp` implements serialization and deserialization of the Simple Management Protocol.\n\nThe SMP specification can be found [here](https://docs.zephyrproject.org/latest/services/device_mgmt/smp_protocol.html).\n\nIf you'd like a library that implements the **serial (UART or USB)**, **Bluetooth (BLE)**, and\n**UDP** transport layers for SMP, take a look at\n[smpclient](https://github.com/intercreate/smpclient).\n\nIf you need an SMP CLI application to interact with device firmware, then try\n[smpmgr](https://github.com/intercreate/smpmgr).\n\n## Install\n\n`smp` is [distributed by PyPI](https://pypi.org/project/smp/) and can be installed with `poetry`, `pip`, and other dependency managers.\n\n## User Documentation\n\nDocumentation is in the source code so that it is available to your editor.\nAn online version is generated and available [here](https://jphutchins.github.io/smp/).\n\n## Development Quickstart\n\n> Assumes that you've already [setup your development environment](#development-environment-setup).\n\n1. activate [envr](https://github.com/JPhutchins/envr), the environment manager for **bash**, **zsh**, and **PS**:\n ```\n . ./envr.ps1\n ```\n2. run `poetry install` when pulling in new changes\n3. run `lint` after making changes\n4. run `test` after making changes\n5. add library dependencies with `poetry`:\n ```\n poetry add <my_new_dependency>\n ```\n6. add test or other development dependencies using [poetry groups](https://python-poetry.org/docs/managing-dependencies#dependency-groups):\n ```\n poetry add -G dev <my_dev_dependency>\n ```\n7. run tests for all supported python versions:\n ```\n tox\n ```\n\n## Development Environment Setup\n\n### Install Dependencies\n\n- poetry==1.8.5: https://python-poetry.org/docs/#installation\n\n### Create the venv\n\n```\npoetry install\n```\n\nThe `venv` should be installed to `.venv`.\n\n### Activate envr\n\n> [envr](https://github.com/JPhutchins/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.\n\n```\n. ./envr.ps1\n```\n\n### Verify Your Setup\n\nTo verify the installation, make sure that all of the tests are passing using these envr aliases:\n\n```\nlint\ntest\n```\n\n### Enable the githooks\n\n> The pre-commit hook will run the linters but not the unit tests.\n\n```\ngit config core.hooksPath .githooks\n```\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Simple Management Protocol (SMP) for remotely managing MCU firmware",
"version": "3.3.1",
"project_urls": {
"Documentation": "https://jphutchins.github.io/smp/",
"Homepage": "https://github.com/JPHutchins/smp",
"Repository": "https://github.com/JPHutchins/smp"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8dbf382896b8c21b81deb0b9bcecab3395e5edb2e8f87df7cf0d02e9c4f999b1",
"md5": "705ece96057e3b645ccd93aae6b46689",
"sha256": "74c946fc70600ce1d2b3924830dfe90464082535bbc88ef4cba814090f375864"
},
"downloads": -1,
"filename": "smp-3.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "705ece96057e3b645ccd93aae6b46689",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.8.1",
"size": 32324,
"upload_time": "2025-02-12T05:19:05",
"upload_time_iso_8601": "2025-02-12T05:19:05.251624Z",
"url": "https://files.pythonhosted.org/packages/8d/bf/382896b8c21b81deb0b9bcecab3395e5edb2e8f87df7cf0d02e9c4f999b1/smp-3.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ebe8b8db6f8786774f0219bdf354aee675b89d2e0a717c2b8f490d33a0f1d7ec",
"md5": "663ee8aba614cfcb4b417c24df4592b0",
"sha256": "c17a4cdfc5087f3f094360a93ed0cfa133f2ab4bbfe39c7c0e86ab39c0e6b07a"
},
"downloads": -1,
"filename": "smp-3.3.1.tar.gz",
"has_sig": false,
"md5_digest": "663ee8aba614cfcb4b417c24df4592b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.8.1",
"size": 26390,
"upload_time": "2025-02-12T05:19:06",
"upload_time_iso_8601": "2025-02-12T05:19:06.620043Z",
"url": "https://files.pythonhosted.org/packages/eb/e8/b8db6f8786774f0219bdf354aee675b89d2e0a717c2b8f490d33a0f1d7ec/smp-3.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 05:19:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JPHutchins",
"github_project": "smp",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "smp"
}
JSON
