======================
python-nitrate
======================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Python API for the Nitrate test case management system
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:Manual section: 1
:Manual group: User Commands
:Date: February 2012
DESCRIPTION
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
python-nitrate is a Python interface to the Nitrate test case
management system. The package consists of a high-level Python
module (provides natural object interface), a low-level driver
(allows to directly access Nitrate's xmlrpc API) and a command
line interpreter (useful for fast debugging and experimenting).
FEATURES
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Among the most essential python-nitrate features are:
* Natural and concise Python interface
* Custom level of caching & logging
* Automated status coloring
* Integrated test suite
* Utility functions
The main motivation was to hide unnecessary implementation details
wherever possible so that using the API is as concise as possible.
Scripts importing python-nitrate can make use of several useful
helper functions including info() for logging to stderr, listed()
which converts list into nice human readable form, color() for
coloring and of course log.{debug,info,warn,error} for logging.
EXAMPLES
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Initialize or create an object::
testcase = TestCase(1234)
testrun = TestRun(testplan=<plan>, summary=<summary>)
Default iterators provided for all container objects::
for case in TestRun(1234):
if case.automated:
case.status = Status("RUNNING")
case.update()
Linking case to a plan is as simple as adding an item to a set::
testplan.testcases.add(testcase)
testplan.update()
However, it's still possible to use the low-level driver when a
specific features is not implemented yet or not efficient enough::
inject = Nitrate()._server.TestCase.get(46490)
For a quick start you can get some inspiration in the examples
directory. The 'matrix.py' script demonstrates how to easily
display a matrix view of the test run results for a specific test
plan. The 'create.py' script gives a broader overview covering
object creation, attribute setting, adjusting logs and caching.
INSTALLATION
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install directly from Fedora/Copr repository using yum or dnf::
yum install python-nitrate
or use PIP (sudo required if not in a virtualenv)::
pip install nitrate
Note that for successfull pip installation several extra
dependencies are necessary::
yum install gcc python-devel krb5-devel postgresql-devel
Here's the list of required packages for Debian systems::
apt install gcc python-dev libkrb5-dev libpq-dev
CONFIGURATION
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To be able to contact the Nitrate server a minimal user config
file ~/.nitrate has to be provided in the user home directory::
[nitrate]
url = https://nitrate.server/xmlrpc/
TEST SUITE
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The high-level interface has an integrated test suite, which can
be easily run against a stage server instance. For this a couple
of objects needs to be prepared and already existing on the server
so that we can check valid results. For detailed information about
what data has to be prepared see the module documentation.
LINKS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Project page:
https://github.com/psss/python-nitrate
Download:
https://github.com/psss/python-nitrate/releases
Copr repo:
http://copr.fedoraproject.org/coprs/psss/python-nitrate/
PyPI:
https://pypi.python.org/pypi/nitrate
File bugs:
https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&component=python-nitrate
Nitrate:
https://fedorahosted.org/nitrate/
SEE ALSO
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Manual pages covering command line interpreter and release notes::
nitrate
nitrate-notes
For more detailed and most up-to-date description of all available
nitrate module features see the Python online documentation::
pydoc nitrate
For area-specific details see respective module documentation::
nitrate.base ......... Nitrate class, search support
nitrate.cache ........ Persistent cache, multicall support
nitrate.config ....... Configuration, logging, coloring, caching
nitrate.containers ... Container classes implementation
nitrate.immutable .... Immutable Nitrate objects
nitrate.mutable ...... Mutable Nitrate objects
nitrate.teiid ........ Teiid support
nitrate.tests ........ Test suite
nitrate.utils ........ Utilities
nitrate.xmlrpc ....... XMLRPC driver
AUTHORS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
High-level Python module:
Petr Šplíchal, Zbyšek Mráz, Martin Kyral, Lukáš Zachar, Filip
Holec, Aleš Zelinka, Miroslav Vadkerti, Leoš Pol, Iveta
Wiedermann, Martin Frodl, Alexander Todorov, Robbie Harwood,
Martin Zelený and Lumír Balhar.
Low-level XMLRPC driver:
Airald Hapairai, David Malcolm, Will Woods, Bill Peck, Chenxiong
Qi, Tang Chaobin, Yuguang Wang and Xuqing Kuang.
Hope, the library will save you time and bring some joy when
writing scripts interacting with the Nitrate server. Looking
forward to your feedback, comments, suggestions and patches ;-)
Petr Šplíchal <psplicha@redhat.com>
COPYRIGHT
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copyright (c) 2012 Red Hat, Inc. All rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
Raw data
{
"_id": null,
"home_page": "https://psss.fedorapeople.org/python-nitrate/",
"name": "nitrate",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Petr \u0160pl\u00edchal",
"author_email": "psplicha@redhat.com",
"download_url": null,
"platform": null,
"description": "\n======================\n python-nitrate\n======================\n\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n Python API for the Nitrate test case management system\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n:Manual section: 1\n:Manual group: User Commands\n:Date: February 2012\n\n\nDESCRIPTION\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\npython-nitrate is a Python interface to the Nitrate test case\nmanagement system. The package consists of a high-level Python\nmodule (provides natural object interface), a low-level driver\n(allows to directly access Nitrate's xmlrpc API) and a command\nline interpreter (useful for fast debugging and experimenting).\n\n\nFEATURES\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nAmong the most essential python-nitrate features are:\n\n * Natural and concise Python interface\n * Custom level of caching & logging\n * Automated status coloring\n * Integrated test suite\n * Utility functions\n\nThe main motivation was to hide unnecessary implementation details\nwherever possible so that using the API is as concise as possible.\n\nScripts importing python-nitrate can make use of several useful\nhelper functions including info() for logging to stderr, listed()\nwhich converts list into nice human readable form, color() for\ncoloring and of course log.{debug,info,warn,error} for logging.\n\n\nEXAMPLES\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nInitialize or create an object::\n\n testcase = TestCase(1234)\n testrun = TestRun(testplan=<plan>, summary=<summary>)\n\nDefault iterators provided for all container objects::\n\n for case in TestRun(1234):\n if case.automated:\n case.status = Status(\"RUNNING\")\n case.update()\n\nLinking case to a plan is as simple as adding an item to a set::\n\n testplan.testcases.add(testcase)\n testplan.update()\n\nHowever, it's still possible to use the low-level driver when a\nspecific features is not implemented yet or not efficient enough::\n\n inject = Nitrate()._server.TestCase.get(46490)\n\nFor a quick start you can get some inspiration in the examples\ndirectory. The 'matrix.py' script demonstrates how to easily\ndisplay a matrix view of the test run results for a specific test\nplan. The 'create.py' script gives a broader overview covering\nobject creation, attribute setting, adjusting logs and caching.\n\n\nINSTALLATION\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nInstall directly from Fedora/Copr repository using yum or dnf::\n\n yum install python-nitrate\n\nor use PIP (sudo required if not in a virtualenv)::\n\n pip install nitrate\n\nNote that for successfull pip installation several extra\ndependencies are necessary::\n\n yum install gcc python-devel krb5-devel postgresql-devel\n\nHere's the list of required packages for Debian systems::\n\n apt install gcc python-dev libkrb5-dev libpq-dev\n\n\nCONFIGURATION\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nTo be able to contact the Nitrate server a minimal user config\nfile ~/.nitrate has to be provided in the user home directory::\n\n [nitrate]\n url = https://nitrate.server/xmlrpc/\n\n\nTEST SUITE\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nThe high-level interface has an integrated test suite, which can\nbe easily run against a stage server instance. For this a couple\nof objects needs to be prepared and already existing on the server\nso that we can check valid results. For detailed information about\nwhat data has to be prepared see the module documentation.\n\n\nLINKS\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nProject page:\nhttps://github.com/psss/python-nitrate\n\nDownload:\nhttps://github.com/psss/python-nitrate/releases\n\nCopr repo:\nhttp://copr.fedoraproject.org/coprs/psss/python-nitrate/\n\nPyPI:\nhttps://pypi.python.org/pypi/nitrate\n\nFile bugs:\nhttps://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&component=python-nitrate\n\nNitrate:\nhttps://fedorahosted.org/nitrate/\n\n\nSEE ALSO\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nManual pages covering command line interpreter and release notes::\n\n nitrate\n nitrate-notes\n\nFor more detailed and most up-to-date description of all available\nnitrate module features see the Python online documentation::\n\n pydoc nitrate\n\nFor area-specific details see respective module documentation::\n\n nitrate.base ......... Nitrate class, search support\n nitrate.cache ........ Persistent cache, multicall support\n nitrate.config ....... Configuration, logging, coloring, caching\n nitrate.containers ... Container classes implementation\n nitrate.immutable .... Immutable Nitrate objects\n nitrate.mutable ...... Mutable Nitrate objects\n nitrate.teiid ........ Teiid support\n nitrate.tests ........ Test suite\n nitrate.utils ........ Utilities\n nitrate.xmlrpc ....... XMLRPC driver\n\n\nAUTHORS\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nHigh-level Python module:\nPetr \u0160pl\u00edchal, Zby\u0161ek Mr\u00e1z, Martin Kyral, Luk\u00e1\u0161 Zachar, Filip\nHolec, Ale\u0161 Zelinka, Miroslav Vadkerti, Leo\u0161 Pol, Iveta\nWiedermann, Martin Frodl, Alexander Todorov, Robbie Harwood,\nMartin Zelen\u00fd and Lum\u00edr Balhar.\n\nLow-level XMLRPC driver:\nAirald Hapairai, David Malcolm, Will Woods, Bill Peck, Chenxiong\nQi, Tang Chaobin, Yuguang Wang and Xuqing Kuang.\n\nHope, the library will save you time and bring some joy when\nwriting scripts interacting with the Nitrate server. Looking\nforward to your feedback, comments, suggestions and patches ;-)\n\nPetr \u0160pl\u00edchal <psplicha@redhat.com>\n\n\nCOPYRIGHT\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nCopyright (c) 2012 Red Hat, Inc. All rights reserved.\n\nThis library is free software; you can redistribute it and/or\nmodify it under the terms of the GNU Lesser General Public\nLicense as published by the Free Software Foundation; either\nversion 2.1 of the License, or (at your option) any later version.\n",
"bugtrack_url": null,
"license": "LGPLv2+",
"summary": "Python API for the Nitrate test case management system",
"version": "1.9.0",
"project_urls": {
"Homepage": "https://psss.fedorapeople.org/python-nitrate/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ba46fd64a5f2b6e575b6dce8ce05e5ac67706b4ffb5e142539a886334ac3227",
"md5": "29cfe4a60aab50eb32444c15f3cb2212",
"sha256": "61b998e4febe9787a1351a25019170a69e1eb9e30b42f1f9ce552a7ac13f3811"
},
"downloads": -1,
"filename": "nitrate-1.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29cfe4a60aab50eb32444c15f3cb2212",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 74877,
"upload_time": "2024-06-28T11:39:21",
"upload_time_iso_8601": "2024-06-28T11:39:21.637806Z",
"url": "https://files.pythonhosted.org/packages/0b/a4/6fd64a5f2b6e575b6dce8ce05e5ac67706b4ffb5e142539a886334ac3227/nitrate-1.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-28 11:39:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nitrate"
}
JSON