<p align=center><a href="https://learn.srlinux.dev"><img src=https://gitlab.com/rdodin/pics/-/wikis/uploads/0102e45007f7fcc357aacdffe61e9555/srl-ndk-py.svg?sanitize=true/></a></p>
---
The Nokia SR Linux NetOps Development Kit (NDK) allows operators to program high-performance, integrated agents that run alongside the Nokia Service Router Linux (SR Linux).
This repository contains generated Python code for [SR Linux NDK Protocol buffers](https://github.com/nokia/srlinux-ndk-protobufs).
## Installation
The Python `srlinux-ndk` package version is synchronized with the SR Linux [NDK protobuf releases](https://github.com/nokia/srlinux-ndk-protobufs).
Use git tags to check out a particular version of the generated package files.
To install the `srlinux-ndk` python package with `pip`, use one of the following:
```bash
# install the latest version from pypi
pip install srlinux-ndk
# install the specific version from pypi
pip install srlinux-ndk==0.1.0
# install the latest version from the main github branch
pip install https://github.com/nokia/srlinux-ndk-py/archive/main.zip
# install the specific version from github
pip install https://github.com/nokia/srlinux-ndk-py/archive/0.1.0.zip
```
These installation steps will install the `srlinux-ndk` package on your system. To import the modules from this package:
```py
from ndk import appid_service_pb2
```
## Code generation
This code has been generated from [SR Linux NDK Protocol buffers](https://github.com/nokia/srlinux-ndk-protobufs) using [`protoc` compiler](https://github.com/srl-labs/protoc-container) with the gRPC plugins for Go and Python.
`gen.sh` script calls the `protoc` container using the ndk protobufs version as its single argument.
```bash
bash gen.sh v0.1.1
```
The python package will appear under `ndk` name in the current working directory.
## Publishing
To publish the generated package on pypi,
1. Change the version of the package in [setup.py](setup.py) accordingly.
2. Create a github release using UI or gh cli tool.
Raw data
{
"_id": null,
"home_page": "https://github.com/nokia/srlinux-ndk-py",
"name": "srlinux-ndk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Nokia",
"author_email": "roman.dodin@nokia.com",
"download_url": "https://files.pythonhosted.org/packages/dd/f0/4917a74bb0816d17da485c8a252de5a7ff48a742ff3db237f39b53ff7b12/srlinux-ndk-0.2.0.tar.gz",
"platform": null,
"description": "<p align=center><a href=\"https://learn.srlinux.dev\"><img src=https://gitlab.com/rdodin/pics/-/wikis/uploads/0102e45007f7fcc357aacdffe61e9555/srl-ndk-py.svg?sanitize=true/></a></p>\n\n---\n\nThe Nokia SR Linux NetOps Development Kit (NDK) allows operators to program high-performance, integrated agents that run alongside the Nokia Service Router Linux (SR Linux).\n\nThis repository contains generated Python code for [SR Linux NDK Protocol buffers](https://github.com/nokia/srlinux-ndk-protobufs).\n\n## Installation\n\nThe Python `srlinux-ndk` package version is synchronized with the SR Linux [NDK protobuf releases](https://github.com/nokia/srlinux-ndk-protobufs).\n\nUse git tags to check out a particular version of the generated package files.\n\nTo install the `srlinux-ndk` python package with `pip`, use one of the following:\n\n```bash\n# install the latest version from pypi\npip install srlinux-ndk\n# install the specific version from pypi\npip install srlinux-ndk==0.1.0\n\n# install the latest version from the main github branch\npip install https://github.com/nokia/srlinux-ndk-py/archive/main.zip\n# install the specific version from github\npip install https://github.com/nokia/srlinux-ndk-py/archive/0.1.0.zip\n```\n\nThese installation steps will install the `srlinux-ndk` package on your system. To import the modules from this package:\n\n```py\nfrom ndk import appid_service_pb2\n```\n\n## Code generation\n\nThis code has been generated from [SR Linux NDK Protocol buffers](https://github.com/nokia/srlinux-ndk-protobufs) using [`protoc` compiler](https://github.com/srl-labs/protoc-container) with the gRPC plugins for Go and Python.\n\n`gen.sh` script calls the `protoc` container using the ndk protobufs version as its single argument.\n\n```bash\nbash gen.sh v0.1.1\n```\n\nThe python package will appear under `ndk` name in the current working directory.\n\n## Publishing\n\nTo publish the generated package on pypi,\n\n1. Change the version of the package in [setup.py](setup.py) accordingly.\n2. Create a github release using UI or gh cli tool.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Nokia SR Linux NetOps Development Kit",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/nokia/srlinux-ndk-py"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d575ac881eca2ab906c488184e5ed6b9ab9ec86881ff4ff7bb94af5d34aef7e7",
"md5": "62a5d3c6878cf837bd915bf4d716e1f1",
"sha256": "8c3005dda924b72e1b5b92faae37c037b75e98a1372c8101a271a5400c2c71b0"
},
"downloads": -1,
"filename": "srlinux_ndk-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "62a5d3c6878cf837bd915bf4d716e1f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28667,
"upload_time": "2023-11-11T21:42:16",
"upload_time_iso_8601": "2023-11-11T21:42:16.781870Z",
"url": "https://files.pythonhosted.org/packages/d5/75/ac881eca2ab906c488184e5ed6b9ab9ec86881ff4ff7bb94af5d34aef7e7/srlinux_ndk-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ddf04917a74bb0816d17da485c8a252de5a7ff48a742ff3db237f39b53ff7b12",
"md5": "cdbaec930cf17be187c1c83ab737569e",
"sha256": "dc45d1595af339d25d44d1204442a0891a97345a953b3c3cca3a39e7424c129e"
},
"downloads": -1,
"filename": "srlinux-ndk-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "cdbaec930cf17be187c1c83ab737569e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15910,
"upload_time": "2023-11-11T21:42:18",
"upload_time_iso_8601": "2023-11-11T21:42:18.227140Z",
"url": "https://files.pythonhosted.org/packages/dd/f0/4917a74bb0816d17da485c8a252de5a7ff48a742ff3db237f39b53ff7b12/srlinux-ndk-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-11 21:42:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nokia",
"github_project": "srlinux-ndk-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "srlinux-ndk"
}
JSON
