| Name | SysrepoLibrary JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | A testing library for Robot Framework that utilizes the Sysrepo tool internally |
| upload_time | 2023-04-19 17:33:24 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6.0 |
| license | Copyright (c) 2023 Deutsche Telekom AG. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
sysrepo
robot
robotframework
networking
linux
testing
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">
Sysrepo Robot Framework Library
</h1>
<p align="center">
<a href="/../../commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/telekom/sysrepo-library-robot-framework?style=flat"></a>
<a href="/../../issues" title="Open Issues"><img src="https://img.shields.io/github/issues/telekom/sysrepo-library-robot-framework?style=flat"></a>
<a href="./LICENSE" title="License"><img src="https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat"></a>
</p>
<p align="center">
<a href="#development">Development</a> •
<a href="#documentation">Documentation</a> •
<a href="#support-and-feedback">Support</a> •
<a href="#how-to-contribute">Contribute</a> •
<a href="#contributors">Contributors</a> •
<a href="#licensing">Licensing</a>
</p>
The goal of this project is to provide a way to use sysreo with the [Robot Framework](https://github.com/robotframework/robotframework).
## About this component
This repository contains a Robot Framework Python library wrapper around the [sysrepo-python](https://github.com/sysrepo/sysrepo-python) sysrepo bindings.
The [examples](./examples/) directory contains a simple example test that connects to sysrepo and does some basic validity checks.
## Development
The following additional dependencies are required to work on the library:
* libyang
* sysrepo
* pip
* setuptools
* wheel
* build
#### Build
First clone the repository:
```
$ git clone https://github.com/telekom/sysrepo-library-robot-framework
```
To build the library run the following commands:
```
$ python3 -m venv sysrepolibrary-venv
$ source sysrepolibrary-venv/bin/activate
$ python3 -m pip install --upgrade pip setuptools wheel build
```
To install it:
```
$ python3 -m pip install .
```
To install the additional dependencies as well (generating the documentation and testing):
```
$ python3 -m pip install .[docs,tests]
```
## Code of Conduct
This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.0 as our code of conduct. Please see the details in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). All contributors must abide by the code of conduct.
## Working Language
We decided to apply _English_ as the primary project language.
Consequently, all content will be made available primarily in English. We also ask all interested people to use English as language to create issues, in their code (comments, documentation etc.) and when you send requests to us. The application itself and all end-user facing content will be made available in other languages as needed.
## Documentation
The documentation for the Sysrepo Robot Framework Library can be generated using the [Sphinx](https://www.sphinx-doc.org/en/master/) documentation generator tool.
The documentation sources are located in [docs/source](./docs/source)
To build the documentation as `HTML` files run while in the root directory:
```
$ sphinx-build -b html docs/source docs/build/html
```
The `-b` option selects a builder in this example it's `HTML`.
To quickly generate the docs use the scripts in the `docs/` directory.
Execute `make` without an argument while in the directory to see which targets are available.
Example for `HTML`:
```
docs/$ make html
```
## Support and Feedback
The following channels are available for discussions, feedback, and support requests:
| Type | Channel |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Issues** | <a href="/../../issues/new/choose" title="General Discussion"><img src="https://img.shields.io/github/issues/telekom/sysrepo-library-robot-framework?style=flat-square"></a> </a> |
| **Other Requests** | <a href="mailto:opensource@telekom.de" title="Email Open Source Team"><img src="https://img.shields.io/badge/email-Open%20Source%20Team-green?logo=mail.ru&style=flat-square&logoColor=white"></a> |
## How to Contribute
Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](./CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times.
## Contributors
Our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.
## Licensing
Copyright (C) 2023 Deutsche Telekom AG.
Licensed under the **BSD 3-Clause License** (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License by reviewing the file [LICENSE](./LICENSE) in the repository.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [LICENSE](./LICENSE) for the specific language governing permissions and limitations under the License.
Raw data
{
"_id": null,
"home_page": "",
"name": "SysrepoLibrary",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": "Juraj Vijtiuk <juraj.vijtiuk@sartura.hr>, Andrej Gardijan <andrej.gardijan@sartura.hr>",
"keywords": "sysrepo,robot,robotframework,networking,linux,testing",
"author": "",
"author_email": "Juraj Vijtiuk <juraj.vijtiuk@sartura.hr>, Andrej Gardijan <andrej.gardijan@sartura.hr>",
"download_url": "https://files.pythonhosted.org/packages/cb/74/9435fca62b6634d787355d94d68b5b65b7ac5a9755a525c6ba690b583c46/SysrepoLibrary-0.1.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n Sysrepo Robot Framework Library\n</h1>\n\n<p align=\"center\">\n <a href=\"/../../commits/\" title=\"Last Commit\"><img src=\"https://img.shields.io/github/last-commit/telekom/sysrepo-library-robot-framework?style=flat\"></a>\n <a href=\"/../../issues\" title=\"Open Issues\"><img src=\"https://img.shields.io/github/issues/telekom/sysrepo-library-robot-framework?style=flat\"></a>\n <a href=\"./LICENSE\" title=\"License\"><img src=\"https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat\"></a>\n</p>\n\n<p align=\"center\">\n <a href=\"#development\">Development</a> \u2022\n <a href=\"#documentation\">Documentation</a> \u2022\n <a href=\"#support-and-feedback\">Support</a> \u2022\n <a href=\"#how-to-contribute\">Contribute</a> \u2022\n <a href=\"#contributors\">Contributors</a> \u2022\n <a href=\"#licensing\">Licensing</a>\n</p>\n\nThe goal of this project is to provide a way to use sysreo with the [Robot Framework](https://github.com/robotframework/robotframework).\n\n## About this component\n\nThis repository contains a Robot Framework Python library wrapper around the [sysrepo-python](https://github.com/sysrepo/sysrepo-python) sysrepo bindings.\n\nThe [examples](./examples/) directory contains a simple example test that connects to sysrepo and does some basic validity checks.\n\n## Development\n\nThe following additional dependencies are required to work on the library:\n\n* libyang\n* sysrepo\n* pip\n* setuptools\n* wheel\n* build\n\n#### Build\n\nFirst clone the repository:\n\n```\n$ git clone https://github.com/telekom/sysrepo-library-robot-framework\n```\n\nTo build the library run the following commands:\n```\n$ python3 -m venv sysrepolibrary-venv\n$ source sysrepolibrary-venv/bin/activate\n$ python3 -m pip install --upgrade pip setuptools wheel build\n```\n\nTo install it:\n```\n$ python3 -m pip install .\n```\n\nTo install the additional dependencies as well (generating the documentation and testing):\n```\n$ python3 -m pip install .[docs,tests]\n```\n\n## Code of Conduct\n\nThis project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.0 as our code of conduct. Please see the details in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). All contributors must abide by the code of conduct.\n\n## Working Language\n\nWe decided to apply _English_ as the primary project language. \n\nConsequently, all content will be made available primarily in English. We also ask all interested people to use English as language to create issues, in their code (comments, documentation etc.) and when you send requests to us. The application itself and all end-user facing content will be made available in other languages as needed.\n\n## Documentation\n\nThe documentation for the Sysrepo Robot Framework Library can be generated using the [Sphinx](https://www.sphinx-doc.org/en/master/) documentation generator tool.\nThe documentation sources are located in [docs/source](./docs/source)\n\nTo build the documentation as `HTML` files run while in the root directory:\n```\n$ sphinx-build -b html docs/source docs/build/html\n```\n\nThe `-b` option selects a builder in this example it's `HTML`.\n\nTo quickly generate the docs use the scripts in the `docs/` directory.\nExecute `make` without an argument while in the directory to see which targets are available.\n\nExample for `HTML`:\n```\ndocs/$ make html\n```\n\n## Support and Feedback\n\nThe following channels are available for discussions, feedback, and support requests:\n\n| Type | Channel |\n| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Issues** | <a href=\"/../../issues/new/choose\" title=\"General Discussion\"><img src=\"https://img.shields.io/github/issues/telekom/sysrepo-library-robot-framework?style=flat-square\"></a> </a> |\n| **Other Requests** | <a href=\"mailto:opensource@telekom.de\" title=\"Email Open Source Team\"><img src=\"https://img.shields.io/badge/email-Open%20Source%20Team-green?logo=mail.ru&style=flat-square&logoColor=white\"></a> |\n\n## How to Contribute\n\nContribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](./CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times.\n\n## Contributors\n\nOur commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.\n\n## Licensing\n\nCopyright (C) 2023 Deutsche Telekom AG.\n\nLicensed under the **BSD 3-Clause License** (the \"License\"); you may not use this file except in compliance with the License.\n\nYou may obtain a copy of the License by reviewing the file [LICENSE](./LICENSE) in the repository.\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [LICENSE](./LICENSE) for the specific language governing permissions and limitations under the License.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023 Deutsche Telekom AG. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "A testing library for Robot Framework that utilizes the Sysrepo tool internally",
"version": "0.1.0",
"split_keywords": [
"sysrepo",
"robot",
"robotframework",
"networking",
"linux",
"testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3c0d34eeb96ae7fa96a5ab09d91cf7b6c5fa5079c3cd068b30e3893d9dde334",
"md5": "68ca16854c2aeb405af94ee255becd33",
"sha256": "ae5dc64407d2d012ee05f8891bf7545326809ff6dbe53af8ec3ee9324ec77f2b"
},
"downloads": -1,
"filename": "SysrepoLibrary-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68ca16854c2aeb405af94ee255becd33",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.0",
"size": 7412,
"upload_time": "2023-04-19T17:33:22",
"upload_time_iso_8601": "2023-04-19T17:33:22.689979Z",
"url": "https://files.pythonhosted.org/packages/d3/c0/d34eeb96ae7fa96a5ab09d91cf7b6c5fa5079c3cd068b30e3893d9dde334/SysrepoLibrary-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb749435fca62b6634d787355d94d68b5b65b7ac5a9755a525c6ba690b583c46",
"md5": "57a6673abbc58641559f74706d39c338",
"sha256": "f46edaed8d0bd6df3bbb7ae3e6d6474f03361e1a4836caed85fc6c178d63b25a"
},
"downloads": -1,
"filename": "SysrepoLibrary-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "57a6673abbc58641559f74706d39c338",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 16260,
"upload_time": "2023-04-19T17:33:24",
"upload_time_iso_8601": "2023-04-19T17:33:24.727532Z",
"url": "https://files.pythonhosted.org/packages/cb/74/9435fca62b6634d787355d94d68b5b65b7ac5a9755a525c6ba690b583c46/SysrepoLibrary-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-19 17:33:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "sysrepolibrary"
}
