Skip to main content

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, 'abandonandrecover` 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

Metadata

Release files for psquared-client 3.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for psquared-client 3.2.1
File Size Uploaded Provenance
psquared_client-3.2.1.tar.gz 20.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for psquared-client 3.2.1
File Interpreter ABI Platform
psquared_client-3.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 43.5 kB

Release files / psquared_client-3.2.1.tar.gz

Download URL psquared_client-3.2.1.tar.gz
Size 20.7 kB
Tags Source
SHA-256 checksum
How to use checksums
76d2474becf1af0c4a53014b4cbe336b5abddfcf1eac7f6d7790c4ead9a71478
BLAKE2b-256 checksum
How to use checksums
1918c6ab991a9e50ad40c34503edbd52f9d098f8608a903f5b383809f5ee72ee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Release files / psquared_client-3.2.1-py3-none-any.whl

Download URL psquared_client-3.2.1-py3-none-any.whl
Size 22.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2d7821fe5bf72c83075ec425b179da795cfb9b3dea4c0bdb2744c5d9dfea1394
BLAKE2b-256 checksum
How to use checksums
7adc1b7c57bf7bccaa77317d32d4bfa65b224ca67a5543ab7062cd408f223911
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Security for psquared-client 3.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page