Ignore:
Timestamp:
28/08/12 13:54:14 (7 years ago)
Author:
pjkersha
Message:

0.2.0 Release

Fixed re-structured text.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/MyProxyWebService/setup.py

    r8128 r8129  
    3131 
    3232The interface is implemented as a WSGI application which fronts a normal  
    33 MyProxyCA server.  myproxy-logon and myproxy-get-trustroots are expressed as web  
    34 service calls.  The WSGI application forwards the requests on to the MyProxy  
    35 server over the usual MyProxy protocol.  The web service interface is RESTful  
    36 using GET and POST operations and the logon interface makes uses of HTTP Basic  
    37 Auth to pass username and pass-phrase credentials.  The service is hosted over  
    38 HTTPS. 
     33MyProxyCA server.  ``myproxy-logon`` and ``myproxy-get-trustroots`` are  
     34expressed as web service calls.  The WSGI application forwards the requests on  
     35to the MyProxy server over the usual MyProxy protocol.  The web service  
     36interface is RESTful using GET and POST operations and the logon interface makes 
     37uses of HTTP Basic Auth to pass username and pass-phrase credentials.  The  
     38service is hosted over HTTPS. 
    3939 
    4040The unit tests include a test application served using paster.  Client scripts 
     
    4646========================= 
    4747The package hierarchy has been reorganised: 
    48  * myproxy.server.wsgi: contains middleware to make calls to a MyProxy service 
    49    using the MyProxyClient package.  It exposes this interface through the  
    50    environ dict so that other middleware or an app can access and use it. 
    51  * myproxy.ws: contains functionality specific to the web service  
    52    interface: 
    53     - myproxy.ws.client: contains all the functionality for web service 
    54       clients to the MyProxy web service.  This includes: 
    55        - shell scripts (.sh suffix) for logon and get trustroots calls.  These  
    56          are implemented with openssl and curl.  Alternative implementations are 
    57          also provided which use wget (-wget.sh suffix) instead of curl.  These 
    58          scripts have also been tested against an independent Short-Lived 
    59          Credential Service developed for the Contrail EU FP7 project. 
    60        - myproxy.ws.client.MyProxyWSClient: is a Python client interface to the  
    61          web service.  The third party package ndg_httpclient is needed for this 
    62          class but note that overall, it is set as an optional install.   
    63     - myproxy.ws.server: contains the server side functionality - a set of WSGI 
    64       middleware and an application to implement logon and get-trustroot web 
    65       service calls. 
     48 * ``myproxy.server.wsgi``: contains middleware to make calls to a MyProxy  
     49   service using the ``MyProxyClient`` package.  It exposes this interface  
     50   through the ``environ`` dict so that other middleware or an app can access  
     51   and use it. 
     52 * ``myproxy.ws``: contains functionality specific to the web service interface: 
     53    - ``myproxy.ws.client``: contains all the functionality for web service clients to the MyProxy web service. This includes: 
     54       + shell scripts (``.sh`` suffix) for logon and get trustroots calls.   
     55         These are implemented with openssl and curl.  Alternative  
     56         implementations are also provided which use wget (``-wget.sh`` suffix) 
     57         instead of curl.  These scripts have also been tested against an  
     58         independent Short-Lived Credential Service developed for the Contrail  
     59         EU FP7 project. 
     60       + ``myproxy.ws.client.MyProxyWSClient``: is a Python client interface to 
     61         the web service.  The third party package ``ndg_httpclient`` is needed 
     62         for this class but note that overall, it is set as an optional install.   
     63    - ``myproxy.ws.server``: contains the server side functionality - a set of  
     64      WSGI middleware and an application to implement logon and get-trustroot  
     65      web service calls. 
    6666 
    6767Prerequisites 
     
    7777Configuration 
    7878============= 
    79 Examples are contained in myproxy.ws.client.test and myproxy.server.test. 
     79Examples are contained in ``myproxy.ws.client.test`` and ``myproxy.server.test``. 
    8080''', 
    8181    author =            'Philip Kershaw', 
Note: See TracChangeset for help on using the changeset viewer.