# `psquared_client` project #
The `psquared_client` project contains both the `psquared_client` package that
provides a python interface to a PSqaured server, and the `pp-cli` command line
interface that uses that package to all copmmand line access to the server.
## `pp-cli` executable ##
More details about the `pp-cli` executable can be found using its help option
pp-cli -h
but here are some examples of retrieving information.
(_Note:_ unless you are using the default local PSquared server you will need to the the environmental
variable `PP_APPLICATION` to point the server you want to use.)
* To list the currently active configurations
pp-cli
* To list the known versions of a given configuration
pp-cli -i <configuration>
* To display the current state of one or more items for a configuration/version.
pp-cli -i -V <version> <configuration> item ...
* To display the history of one or more items for a configuration/version.
pp-cli -H -V <version> <configuration> item ...
* As an alternate, the list of items to be acted upon can be supplied in a file with one item per line.
Thus the following displays the current state of a set of items listed in a file for a configuration/version.
pp-cli -i -f <file> -V <version> <configuration>
Here are some examples of commands that affect the state of PSquared.
(_Note:_ you may need an authorized certificate to execute these types of commands.)
* To submit one or more items for processing with a configuration/version.
pp-cli -i -s -V <version> <configuration> item ...
* To resolve the failure of one or more items for a configuration/version.
pp-cli -i --resolve -V <version> <configuration> item ...
The other transitions, `submit`, `cancel`, `reset`, 'abandon` and `recover` have similar options.
## `psquared_client` package ##
The `psquared_client` package provides the `PSquared` class that can be used to
access a PSqaured server and a `Display` module that can display the responses
of a PSquared server in a readable format.
### `PSquared` class ###
The `PSquared` class provides various documents in reponse to a request to the
PSquared server. The documents are in the form of a standard python
`ElementTree`. Currently the following methods are supported.
* `get_application` - returns the application document at the URL
* `get_configuration` - returns the configuration document the named configuration
* `get_report` - returns the requested report document
* `execute_submissions` - submits a list of items for processing
* `execute_transitions` - execute a transition for a list of items
### `Display` module ###
The `Display` modules provides various methods for displaying the reponses that
result from a request to the PSquared server. Currently the following methods
are supported.
* `configurations` - displays all the configurations contained in an application document
* `versions` - displays all the versions of a named configuration
* `entry` - displays the state of a given item
* `info` - displays the states of a set of items contained in a report
* `histories` - displays the history of one or more items contained in history document
Raw data
{
"_id": null,
"home_page": "",
"name": "psquared-client",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": "",
"keywords": "psqured,psquared_client,pp-cli",
"author": "",
"author_email": "Simon Patton <sjpatton@lbl.gov>",
"download_url": "https://files.pythonhosted.org/packages/19/18/c6ab991a9e50ad40c34503edbd52f9d098f8608a903f5b383809f5ee72ee/psquared_client-3.2.1.tar.gz",
"platform": null,
"description": "# `psquared_client` project #\n\nThe `psquared_client` project contains both the `psquared_client` package that\nprovides a python interface to a PSqaured server, and the `pp-cli` command line\ninterface that uses that package to all copmmand line access to the server.\n\n\n## `pp-cli` executable ##\n\nMore details about the `pp-cli` executable can be found using its help option\n\n pp-cli -h\n\nbut here are some examples of retrieving information.\n(_Note:_ unless you are using the default local PSquared server you will need to the the environmental\nvariable `PP_APPLICATION` to point the server you want to use.)\n\n* To list the currently active configurations\n\n pp-cli\n\n* To list the known versions of a given configuration\n\n pp-cli -i <configuration>\n\n\n* To display the current state of one or more items for a configuration/version.\n\n pp-cli -i -V <version> <configuration> item ...\n\n* To display the history of one or more items for a configuration/version.\n\n pp-cli -H -V <version> <configuration> item ...\n\n* As an alternate, the list of items to be acted upon can be supplied in a file with one item per line.\n Thus the following displays the current state of a set of items listed in a file for a configuration/version.\n\n pp-cli -i -f <file> -V <version> <configuration>\n\n\nHere are some examples of commands that affect the state of PSquared.\n(_Note:_ you may need an authorized certificate to execute these types of commands.)\n\n* To submit one or more items for processing with a configuration/version.\n\n pp-cli -i -s -V <version> <configuration> item ...\n\n* To resolve the failure of one or more items for a configuration/version.\n\n pp-cli -i --resolve -V <version> <configuration> item ...\n\n The other transitions, `submit`, `cancel`, `reset`, 'abandon` and `recover` have similar options.\n\n\n## `psquared_client` package ##\n\nThe `psquared_client` package provides the `PSquared` class that can be used to\naccess a PSqaured server and a `Display` module that can display the responses\nof a PSquared server in a readable format.\n\n\n### `PSquared` class ###\n\nThe `PSquared` class provides various documents in reponse to a request to the\nPSquared server. The documents are in the form of a standard python\n`ElementTree`. Currently the following methods are supported.\n\n* `get_application` - returns the application document at the URL\n* `get_configuration` - returns the configuration document the named configuration\n* `get_report` - returns the requested report document\n* `execute_submissions` - submits a list of items for processing\n* `execute_transitions` - execute a transition for a list of items\n\n\n### `Display` module ###\n\nThe `Display` modules provides various methods for displaying the reponses that\nresult from a request to the PSquared server. Currently the following methods\nare supported.\n\n* `configurations` - displays all the configurations contained in an application document\n* `versions` - displays all the versions of a named configuration\n* `entry` - displays the state of a given item\n* `info` - displays the states of a set of items contained in a report\n* `histories` - displays the history of one or more items contained in history document\n",
"bugtrack_url": null,
"license": "BSD-3-Clause-LBNL",
"summary": "Manage the connection and communications to a PSquared server.",
"version": "3.2.1",
"project_urls": null,
"split_keywords": [
"psqured",
"psquared_client",
"pp-cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7adc1b7c57bf7bccaa77317d32d4bfa65b224ca67a5543ab7062cd408f223911",
"md5": "f28bd3ef7144b3328b659ed3311a551e",
"sha256": "2d7821fe5bf72c83075ec425b179da795cfb9b3dea4c0bdb2744c5d9dfea1394"
},
"downloads": -1,
"filename": "psquared_client-3.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f28bd3ef7144b3328b659ed3311a551e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 22800,
"upload_time": "2023-08-21T17:18:40",
"upload_time_iso_8601": "2023-08-21T17:18:40.459458Z",
"url": "https://files.pythonhosted.org/packages/7a/dc/1b7c57bf7bccaa77317d32d4bfa65b224ca67a5543ab7062cd408f223911/psquared_client-3.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1918c6ab991a9e50ad40c34503edbd52f9d098f8608a903f5b383809f5ee72ee",
"md5": "ded6d49643726a305f823e02102ececf",
"sha256": "76d2474becf1af0c4a53014b4cbe336b5abddfcf1eac7f6d7790c4ead9a71478"
},
"downloads": -1,
"filename": "psquared_client-3.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ded6d49643726a305f823e02102ececf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 20679,
"upload_time": "2023-08-21T17:18:42",
"upload_time_iso_8601": "2023-08-21T17:18:42.198807Z",
"url": "https://files.pythonhosted.org/packages/19/18/c6ab991a9e50ad40c34503edbd52f9d098f8608a903f5b383809f5ee72ee/psquared_client-3.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-21 17:18:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "psquared-client"
}
JSON