Skip to main content

Manage the connection and communications to a PSquared server.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

psquared_client-2.3.1.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

psquared_client-2.3.1-py2.py3-none-any.whl (16.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file psquared_client-2.3.1.tar.gz.

File metadata

  • Download URL: psquared_client-2.3.1.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

File hashes

Hashes for psquared_client-2.3.1.tar.gz
Algorithm Hash digest
SHA256 b675207531bd7f5a107ffe5cdb4fcb581f4d5fe546ca6eb382216c2cd675a6eb
MD5 ac926aa8294c8947f413aea8afd53cbd
BLAKE2b-256 b980c894dad02e0e12924243ec586154f77883cdfd37ee3a36a5aca903483f30

See more details on using hashes here.

File details

Details for the file psquared_client-2.3.1-py2.py3-none-any.whl.

File metadata

  • Download URL: psquared_client-2.3.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

File hashes

Hashes for psquared_client-2.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b447204da73b69f3038ebe64942c74e3fba40e42e739aee97179dd48cc8f37bc
MD5 b1d9c7df1986f0e02b9db5e4d99acca7
BLAKE2b-256 562e111c9aaac90aa1fe0d573d27d3ef643280af433d0a90b145fca45bfb4874

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page