Package: robotframework-sysrepolibrary
Sysrepo Robot Framework LibraryDevelopment•Documentation•Support•Contribute•Contributors•LicensingThe goal of this project is to provide a way to use sysrepo with theRobot Framework.About this componentThis repository contains a Robot Framework Python library wrapper around thesysrepo-pythonsysrepo bindings.Theexamplesdirectory contains a simple example test that connects to sysrepo and does some basic validity checks.DevelopmentThe following additional dependencies are required to work on the library:libyangsysrepoxmltodictpipsetuptoolswheelbuildInstallationThe recommended installation method is usingpip:$ python3 -m pip install robotframework-sysrepolibraryWith recent versions ofpipit is also possible to install directly from theGitHubrepository.
To install from the latest source from the master branch, use the following command:$ python3 -m pip install git+https://github.com/telekom/sysrepo-library-robot-framework.gitBuildFirst clone the repository:$ git clone https://github.com/telekom/sysrepo-library-robot-frameworkTo 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 buildTo 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 ConductThis project has adopted theContributor Covenantin version 2.0 as our code of conduct. Please see the details in ourCODE_OF_CONDUCT.md. All contributors must abide by the code of conduct.Working LanguageWe decided to applyEnglishas 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.DocumentationThe documentation for the Sysrepo Robot Framework Library can be generated using theSphinxdocumentation generator tool.
The documentation sources are located indocs/sourceTo build the documentation asHTMLfiles run while in the root directory:$ sphinx-build -b html docs/source docs/build/htmlThe-boption selects a builder in this example it'sHTML.To quickly generate the docs use the scripts in thedocs/directory.
Executemakewithout an argument while in the directory to see which targets are available.Example forHTML:docs/$ make htmlSupport and FeedbackThe following channels are available for discussions, feedback, and support requests:TypeChannelIssuesOther RequestsHow to ContributeContribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see ourContribution Guidelines. By participating in this project, you agree to abide by itsCode of Conductat all times.ContributorsOur commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.LicensingCopyright (C) 2023 Deutsche Telekom AG.Licensed under theBSD 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 fileLICENSEin 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 theLICENSEfor the specific language governing permissions and limitations under the License.