.. Copyright (C) 2019, Nokia
.. image:: https://travis-ci.org/nokia/crl-rfcli.svg?branch=master
:target: https://travis-ci.org/nokia/crl-rfcli
Robot Framework Frontend Library
================================
About
-----
Robot Framework frontend script.
Documentation
-------------
Documentation for ``crl.rfcli`` can be found from `Read The Docs`_.
.. _Read The Docs: http://crl-rfcli.readthedocs.io/
Installation
------------
The package can be installed with pip::
# pip install crl.rfcli
Test Execution
--------------
Test cases are executed with "rfcli" command. It adds **./libraries** and
**./resources** to PYTHONPATH so that you can easily import libraries and resources
in test cases.
Additionally, it will recursively search the **./testcases** directory for
any subdirectories named **libraries** or **resources** and add those to PYTHONPATH.
**Rfcli** reads the target information for targets specified with **-t option** from
config files. The target config files can be either in INI or YAML format.
It exports the variables to the test execution environment as RFCLI_TARGET_1.IP etc.
Use the -t and --rfcli-show options together to see how it works.
Test case output is directed to *$HOME/public_html/rfcli* if the directory
exists.
Examples
--------
::
rfcli -t foundcloud1 --suite framework.use_targets testcases
The target parameter can be specified in the following ways:
#. The name of the target system can be specified without any extension.
The corresponding file with the .ini or .yaml extension must exist in the targets directory.::
rfcli -t targetname
#. A target file can be specified with an absolute or a relative path including one of the supported extensions.
The extension can be .ini or .yaml::
rfcli -t /home/fedora/gitlab/crl/targetname.ini
rfcli -t ../../gitlab/crl/targetname.ini
rfcli -t /home/fedora/gitlab/crl/targetname.yaml
rfcli -t ../../gitlab/crl/targetname.yaml
More than one target system can be specified.
The name of each target will be exported to an enumerated Robot variable. The
name of the first target will be exported to RFCLI_TARGET_1, the second one to
RFCLI_TARGET_2 and so on.
The target properties are read from the INI file and later available as Robot
variables RFCLI_TARGET_1.IP, RFCLI_TARGET_2.USER, etc...
The target properties in the YAML file can be in a nested structure. The
properties are read from the file. Each property name is prefixed by the names
of each level of nesting leading to it and separated by ".". The properties
are available as Robot variables
RFCLI_TARGET_1.ENV.PARAMETERS.EXTERNAL_NETWORKS.EXT0,
RFCLI_TARGET_1.ENV_PARAMETERS.NTP_SERVERS, etc...
Contributing
------------
Please see contributing_ for development and contribution practices.
The code_ and the issues_ are hosted on GitHub.
The project is licensed under BSD-3-Clause_.
.. _contributing: https://github.com/nokia/crl-rfcli/blob/master/CONTRIBUTING.rst
.. _code: https://github.com/nokia/crl-rfcli
.. _issues: https://github.com/nokia/crl-rfcli/issues
.. _BSD-3-Clause: https://github.com/nokia/crl-rfcli/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/nokia/crl-rfcli",
"name": "crl.rfcli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<3.13",
"maintainer_email": "",
"keywords": "robotframework",
"author": "Krisztina Ylinen",
"author_email": "krisztina.ylinen@nokia.com",
"download_url": "https://files.pythonhosted.org/packages/04/62/9bae0a18faa35d191913c1a2a8146a2759df5ba3cd404ea9ab4b082e278c/crl.rfcli-2.0.0.tar.gz",
"platform": null,
"description": ".. Copyright (C) 2019, Nokia\n\n.. image:: https://travis-ci.org/nokia/crl-rfcli.svg?branch=master\n :target: https://travis-ci.org/nokia/crl-rfcli\n\nRobot Framework Frontend Library\n================================\n\nAbout\n-----\n\nRobot Framework frontend script.\n\nDocumentation\n-------------\n\nDocumentation for ``crl.rfcli`` can be found from `Read The Docs`_.\n\n.. _Read The Docs: http://crl-rfcli.readthedocs.io/\n\nInstallation\n------------\n\nThe package can be installed with pip::\n\n # pip install crl.rfcli\n\nTest Execution\n--------------\n\nTest cases are executed with \"rfcli\" command. It adds **./libraries** and\n**./resources** to PYTHONPATH so that you can easily import libraries and resources\nin test cases.\nAdditionally, it will recursively search the **./testcases** directory for\nany subdirectories named **libraries** or **resources** and add those to PYTHONPATH.\n\n**Rfcli** reads the target information for targets specified with **-t option** from\nconfig files. The target config files can be either in INI or YAML format.\nIt exports the variables to the test execution environment as RFCLI_TARGET_1.IP etc.\nUse the -t and --rfcli-show options together to see how it works.\n\nTest case output is directed to *$HOME/public_html/rfcli* if the directory\nexists.\n\nExamples\n--------\n\n::\n\n rfcli -t foundcloud1 --suite framework.use_targets testcases\n\nThe target parameter can be specified in the following ways:\n\n#. The name of the target system can be specified without any extension.\n The corresponding file with the .ini or .yaml extension must exist in the targets directory.::\n\n rfcli -t targetname\n\n#. A target file can be specified with an absolute or a relative path including one of the supported extensions.\n The extension can be .ini or .yaml::\n\n rfcli -t /home/fedora/gitlab/crl/targetname.ini\n rfcli -t ../../gitlab/crl/targetname.ini\n\n rfcli -t /home/fedora/gitlab/crl/targetname.yaml\n rfcli -t ../../gitlab/crl/targetname.yaml\n\nMore than one target system can be specified.\n\nThe name of each target will be exported to an enumerated Robot variable. The\nname of the first target will be exported to RFCLI_TARGET_1, the second one to\nRFCLI_TARGET_2 and so on.\n\nThe target properties are read from the INI file and later available as Robot\nvariables RFCLI_TARGET_1.IP, RFCLI_TARGET_2.USER, etc...\n\nThe target properties in the YAML file can be in a nested structure. The\nproperties are read from the file. Each property name is prefixed by the names\nof each level of nesting leading to it and separated by \".\". The properties\nare available as Robot variables\nRFCLI_TARGET_1.ENV.PARAMETERS.EXTERNAL_NETWORKS.EXT0,\nRFCLI_TARGET_1.ENV_PARAMETERS.NTP_SERVERS, etc...\n\nContributing\n------------\n\nPlease see contributing_ for development and contribution practices.\n\nThe code_ and the issues_ are hosted on GitHub.\n\nThe project is licensed under BSD-3-Clause_.\n\n.. _contributing: https://github.com/nokia/crl-rfcli/blob/master/CONTRIBUTING.rst\n.. _code: https://github.com/nokia/crl-rfcli\n.. _issues: https://github.com/nokia/crl-rfcli/issues\n.. _BSD-3-Clause: https://github.com/nokia/crl-rfcli/blob/master/LICENSE\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Robot Framework commands library",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/nokia/crl-rfcli"
},
"split_keywords": [
"robotframework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9826b19a905602c4e1f6b6e4526151d2baf7ce0c297c74f80833cf9ffa9612c5",
"md5": "9023ad4f9bf6917e7b4aa161d84725a0",
"sha256": "77b5ca4ee0856d6e6d13be321849170b7841ca23a47cde3e9506adeb83d136d3"
},
"downloads": -1,
"filename": "crl.rfcli-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9023ad4f9bf6917e7b4aa161d84725a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<3.13",
"size": 10017,
"upload_time": "2024-03-04T10:47:26",
"upload_time_iso_8601": "2024-03-04T10:47:26.927756Z",
"url": "https://files.pythonhosted.org/packages/98/26/b19a905602c4e1f6b6e4526151d2baf7ce0c297c74f80833cf9ffa9612c5/crl.rfcli-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "04629bae0a18faa35d191913c1a2a8146a2759df5ba3cd404ea9ab4b082e278c",
"md5": "09ead7e6bf44cbcd3d9b61948294eaf5",
"sha256": "baacdf764af24a83994fbcb1b641df80d3db59229c6f9970cd98b21c9322ff0b"
},
"downloads": -1,
"filename": "crl.rfcli-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "09ead7e6bf44cbcd3d9b61948294eaf5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<3.13",
"size": 23672,
"upload_time": "2024-03-04T10:47:28",
"upload_time_iso_8601": "2024-03-04T10:47:28.679099Z",
"url": "https://files.pythonhosted.org/packages/04/62/9bae0a18faa35d191913c1a2a8146a2759df5ba3cd404ea9ab4b082e278c/crl.rfcli-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 10:47:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nokia",
"github_project": "crl-rfcli",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"tox": true,
"lcname": "crl.rfcli"
}
JSON
